Skip to main content
POST
/
partner
/
v1
/
customers
/
link
Create customer link URL
curl --request POST \
  --url https://api.rabot-charge.de/partner/v1/customers/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "successUrl": null,
  "failureUrl": null,
  "signUpUrl": "<string>",
  "authAs": "<string>",
  "customerNumberQueryParameterName": "customerNumber",
  "externalCustomerId": null
}
'
{
  "authorizationUrl": "<string>"
}
This endpoint allows you to start the customer linking process, which is used to request authorization from a customer to access their customer and contract data in the RABOT platform. See the guide for more details. After the customer approves the request, you can access all customer and contract data via the API, until the access is revoked, either by the customer support team, or by using the API endpoint delete customer link.
Note that the link returned by the API only has a limited validity of 10 minutes. If an end user tries to login using the link after the 10 minutes have expired, the login will fail, and you will have to create a new link again to re-start the process.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Contains details needed for creating the link including success/failure URLs and external customer identifier.

​
successUrl
string<uri> | null

URL to redirect to in case of success. If NULL, then no redirect will be performed.

​
failureUrl
string<uri> | null

URL to redirect to in case of error. If NULL, then no redirect will be performed.

​
signUpUrl
string<uri> | null

URL used for sign-up. If not set, the sign-up link will not be displayed.

​
authAs
string | null

Optional slug of the partner to authenticate as for linking.

​
customerNumberQueryParameterName
string
default:customerNumber

Name of the query parameter in success redirect, that contains the customer number.

​
externalCustomerId
string | null

If set, this value will be assigned to the customer as external customer identifier after successful linking. Subsequently, it can be used to retrieve the customer via Partner API.

Response

OK

​
authorizationUrl
string<uri>
required