Medipim FR - API V4

Developer documentation

POST /v4/api-keys/create

(Last updated: 21/06/2024)

Access to this feature is restricted and depends on your subscription type.

This endpoint allows for creating a new API key for a user.

Request

Method

POST

URL

https://api.medipim.fr/v4/api-keys/create

Headers

Body

  • user: Medipim ID of the user (integer, required)
  • name: Descriptive text to describe what the key will be used for (string, required)

Response

Body

  • apiKey:
    • id: API key ID (integer)
    • name: Text describing what the API should be used for (string)
    • secret: Text hash that is used to indentify the API key (integer)
    • isEnabled: Status of the API key (boolean)