An app gives your own software access to the Softalon API at https://api.softalon.com/v1. Each app has a client ID and a client secret, which it uses to get access tokens with OAuth 2.0.
There are two kinds of apps:
Create a salon app
Before you start
- Your salon is on the Ultimate plan.
- You have the Super Administrator or Owner role.
- 1
Step 1 of 5
Open Apps
Go to Settings › Developers › Apps and click Create App.
- 2
Step 2 of 5
Name the app
Enter an App Name. People see this name when they're asked to authorize your app.
- 3
Step 3 of 5
Add scopes
In Scopes, add each permission your app needs, one at a time. Your app can only request scopes you add here. See the scope list below.
- 4
Step 4 of 5
Add redirect URIs
In Redirect URIs, add every full URL your app uses to receive OAuth responses, for example
https://app.example.com/oauth/callback. Your app can only use URIs you add here. You can skip this if your app only talks to the API from a server. - 5
Step 5 of 5
Create the app and save the secret
Click Create App.
You will see:A credentials dialog with your Client ID and Client Secret.
Copy both and store them somewhere safe right away.
The client secret is shown only once. After you close the dialog, the table shows a masked version. If you lose the secret, delete the app and create a new one.
Create an account app
Go to Account › Apps and click Register App. The fields and the one-time secret work the same way as for a salon app.
Scopes
Scopes have the form area:action.
Add only the scopes your app needs.
Getting tokens
Apps support these OAuth 2.0 grant types:
- Client credentials, for server-to-server access without a user.
- Authorization code, when a person signs in and approves your app. See Allow an app to access your account.
- Refresh token, to get new access tokens without asking again.
When your app requests a token, it sends its client ID and secret with HTTP Basic authentication.
Edit or delete an app
Open the app's menu in the table:
- Update changes the name, scopes or redirect URIs. The client ID and secret stay the same.
- Delete removes the app and its credentials. Any system using them can no longer get tokens.
Common questions
No. It's only shown when the app is created. Delete the app and create a new one to get a new secret.