Créer une application API

Une application donne à votre propre logiciel accès à l'API Softalon à l'adresse https://api.softalon.com/v1. Chaque application possède un ID client et un secret client, qu'elle utilise pour obtenir des jetons d'accès avec OAuth 2.0.

Il existe deux types d'applications :

Créer une application de salon

1. 1

   Étape 1 sur 5

   Ouvrez Applications

   Allez dans Paramètres › Développeurs › Applications et cliquez sur Créer une application.

2. 2

   Étape 2 sur 5

   Nommez l'application

   Saisissez un Nom de l'application. Les utilisateurs voient ce nom lorsqu'on leur demande d'autoriser votre application.

3. 3

   Étape 3 sur 5

   Ajoutez des scopes

   Dans Scopes, ajoutez une à une chaque autorisation dont votre application a besoin. Votre application ne peut demander que les scopes ajoutés ici. Consultez la liste des scopes ci-dessous.

4. 4

   Étape 4 sur 5

   Ajoutez des URI de redirection

   Dans URI de redirection, ajoutez chaque URL complète que votre application utilise pour recevoir les réponses OAuth, par exemple https://app.example.com/oauth/callback. Votre application ne peut utiliser que les URI ajoutées ici. Vous pouvez ignorer cette étape si votre application communique avec l'API uniquement depuis un serveur.

5. 5

   Étape 5 sur 5

   Créez l'application et enregistrez le secret

   Cliquez sur Créer l'application.

   Vous verrez:

   Une boîte de dialogue d'identifiants avec votre ID client et votre Secret client.

   Copiez les deux et conservez-les immédiatement en lieu sûr.

Créer une application de compte

Allez dans Compte › Applications et cliquez sur Enregistrer une application. Les champs et le secret affiché une seule fois fonctionnent de la même façon que pour une application de salon.

Scopes

Les scopes ont la forme domaine:action.

N'ajoutez que les scopes dont votre application a besoin.

Obtenir des jetons

Les applications prennent en charge ces types d'autorisation OAuth 2.0 :

• Client credentials, pour un accès de serveur à serveur sans utilisateur.
• Authorization code, lorsqu'une personne se connecte et approuve votre application. Consultez Autoriser une application à accéder à votre compte.
• Refresh token, pour obtenir de nouveaux jetons d'accès sans redemander l'autorisation.

Lorsque votre application demande un jeton, elle envoie son ID client et son secret avec l'authentification HTTP Basic.

Modifier ou supprimer une application

Ouvrez le menu de l'application dans le tableau :

• Mettre à jour modifie le nom, les scopes ou les URI de redirection. L'ID client et le secret restent les mêmes.
• Supprimer retire l'application et ses identifiants. Les systèmes qui les utilisent ne peuvent plus obtenir de jetons.