Warning: you are about to manage your Rest API Client Id

A clientId is a REST API login, it works in pair with a dedicated clientSecret.

Some connectors refer to "clientId/clientSecret" with "login/password" terms, REST APIs require either : only the sellerId (through an agregator), or 3 information (clientId/clientSecret/sellerId).
If only 2 are requested please check with your integration partner.

I'm using a feed agregator

Connect your agregator to your Seller Account.

Please make sure your agregator has registered with us before and is using the REST API.

My agregator only requests my SellerId I know my agregator's clientId
My agregator requires a clientId, clientSecret and SellerId

How to know ?

Using delegated REST, agregators request : a single sellerId.

Some agregators request a complete set of clientId/clientSecret and sellerId.

I'm using a plugin

Get credentials for your website Plugin .

Works for direct connection plugins only, which expect 3 parameters : clientId, clientSecret and SellerId.

For third party issued plugins use "Agregator connexion" (above).

I already have a clientId I need a new clientId

Make sure your plugin is REST Compatible

Rest compatible plugins require clientId/clientSecret/SellerId.

Older plugins only required a login and a password, those API sets are considered legacy and deprecated.

I'm developping myself or with a development partner

Connect to REST APIs with your Seller Account.

Using the REST API requires a clientId/clientSecret pair, and a link with your SellerAccount.

I need a new clientId Manage my existing clientId Link my SellerAccount and my clientId

I'm a developper, or a feed agregator, I just need credentials

I'm an agregator or technical integration partner

You might just need a clientId and do not want to link it to a seller account ?

Start by creating an account, stop after retrieving credentials.

Create a clientId

Notes

A single clientId, not linked to any seller account, will not grant you access to any data outside of the public test seller.

ClientIds which are not linked to any seller account are regularly removed, only create one if you plan on using it.

Notice: You will need your Seller Credentials during this process.

Please follow the next steps to link your Seller Account with Rest API access credentials.

Start with your Client Id :

Notice: You will need your Seller Credentials during this process.

Please follow the next steps to link your Seller Account with Rest API access credentials.

Start with your Client Id :

Choosing a good client id.

Simply using your company name or shop name is a good start
It should use simple caracters, can include digits and dashes
Avoid using an email address
You cannot use your octopia account email
It is advised when useful to append your target usecase
(add your plugin or website name at the end)

This form does not enable linking to a seller account.

Start with your Client Id :

Choosing a good client id.

Simply using your company name is a good start
It should use simple caracters, can include digits and dashes
Avoid using an email address
Inquire for help of needed through Octopia api support teams

Notice: You will need your Seller Credentials during this process.

Please follow the next steps to allow your agregator to access your Seller Account data.

You will be provided your SellerId when complete which you can provide to your agregator.

Pick your agregator to grant access rights :

< Back to method selector

What to do when your agregator is not readily available for access grants :

You already know their client id

Agregators which are not listed here might prefer communicating their clientId

You can then just input this value and grant rights to them

Make sure they are using the REST API

Check which information they expect to complete your setup

There are multiple ways for an agregator to interact with Octopia APIs

When multiple information is requested (clientId/clientSecret/sellerId), this connection method will not be available

You are using a plugin from your agregator

Depending on how this plugin interacts with Octopia or your agregator's systems, you might not need to go through this process

Confirm with them which information they require

Standalone plugins not relying on any third party and which handle direct connectivity to Octopia require a dedicated clientId.

I need a new clientId

They should be here ?

Newly added agregators might take some time to appear

Check with them if they did register with Octopia

or get in touch with us through the help center

Notice: You will need your Seller Credentials during this process.

Please follow the next steps to link your Seller Account with Rest API access credentials.

Start with your provided client Id

Your agregator requires you to grant access to your Seller account.
To do so, you were given a clientId to which you need to grant access.

Starting here, give the target clientId and link your seller account.