Skip to content

FAQ - API

What are the necessary steps to create an assignment for a car and an user?

Please find our Step-by-Step Guide here.

I am unable to see the Developer menu item in the flinkey Portal. How can I solve this problem?

Please write an e-mail to flinkey@plan-b-gmbh.com and describe your problem. Afterwards someone will grant you access to the Developer page of the flinkey Portal.

What are the required accounts to consume the flinkey API?

You need an API Manager.

You can administer the API Manager accounts via Developer page of the flinkey Portal. Please write an e-mail to flinkey@plan-b-gmbh.com if you are unable to see the Developer menu item in the flinkey Portal. Afterwards someone will grant you access to the Developer page of the flinkey Portal. After creating an API Manager you need it to request a token via corresponding OAuth2 endpoint of the flinkey API. You need to send this token within every other request you send to the flinkey API as follows:
Key: Authorization | Value: Bearer ...

Recommendation: The API Manager should be created using non-personalized e-mail address.

Does the flinkey API have quotas?

No, the flinkey API doesn't have quotas. Please don't use unit tests with our production environment. In case we see a lot of API calls because of unit tests etc. from your accounts we reserve the right to introduce quotas. Please reach us at flinkey@plan-b-gmbh.com if you want to get access to our testing environment.

What is the difference between flinkey-API-Key and Authorization header?

The flinkey-API-Key is a static header-based authorization mechanism. You need to add the flinkey-API-Key to every request you send to the flinkey API. The Authorization header is an OAuth2 header-based authorization mechanism. Just get your JWT via OAuth2 endpoint and then send the received JWT in each other request as follows:
Key: Authorization | Value: Bearer ...

Could an API Manager have access to multiple customers?

Yes, you can assign one API Manager to multiple customers but we recommend using one API Manager per customer.

What is the difference between anonymous and normal user?

An anonymous user is just an anonymous e-mail address. Anonymous users can't login to the flinkey App unlike normal users could. Anonymous users fit perfectly if you want to use your own mobile application.

Do you have a testing environment?

Yes, we have a testing environment for our API consumers. Please write an e-mail to flinkey@plan-b-gmbh.com. We will get back to you with the next steps regarding testing environment setup.