Onboarding - APIkey Endpoint

This documentation describes, how to create an API endpoint for receiving Ropo One API-keys of the new profiles, which have been created via Onboarding API.

Before Ropo One can send new profile's API-key, new profile's eligible person must accept Ropo One "terms & conditions" via strong authentication. When the agreement has been successfully accepted (+ KYC-process completed if applicable), API-keys will be sent automatically to your APIkey endpoint.

Structure of APIkey Endpoint

Please provide these values to your Ropo contact person both for test and production

• URL of the endpoint
• APIkey for the endpoint

Endpoint Structure

Example JSON:

{
    "bid": "1234567-8",
    "external-id": "a3029a45-2608-4c9c-a8ce-93fcbcb733a7",
    "cid": "123123",
    "apicode": "ABCDEFG123"
}

• bid = company Business ID
• external-id

  • external-id is an optional tag with Ropo One onboarding API. Usually external-id refers to your customer unique ID in ERP-platform. If external-id has been given with original onboarding API request, it is included automatically to help you to match the new Ropo One Profile apikey with the correct Business ID in your ERP
• cid = New profile's ID in Ropo One
• apicode = New profile's APIcode

When new Ropo One profile starts to use Ropo One API (like for sending invoices), cid & apikey pair is needed for API authentication

Example curl from Ropo One to your APIkey endpoint:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "bid": "1234567-8", \ 
   "external-id": "a3029a45-2608-4c9c-a8ce-93fcbcb733a7", \
   "cid": "123123", \
   "apicode": "ABCDEFG123" \ 
 }' 'https://your.endpoint/xxx'

Tag "external-id" is an optional tag with Ropo One onboarding API. Usually external-id refers to your customer unique ID in ERP-platform. If external-id has been given with original onboarding API request, it is included automatically to help you to match the new Ropo One Profile apikey with the correct Business ID in your ERP.