Um app dá ao seu próprio software acesso à API do Softalon em https://api.softalon.com/v1. Cada app tem um client ID e um client secret, que ele usa para obter tokens de acesso com OAuth 2.0.
Existem dois tipos de apps:
Crie um app do salão
Antes de começar
- Seu salão está no plano Ultimate.
- Você tem a função Super Administrador ou Proprietário.
- 1
Etapa 1 de 5
Abra os apps
Acesse Configurações › Desenvolvedores › Apps e clique em Criar App.
- 2
Etapa 2 de 5
Dê um nome ao app
Digite um Nome do App. As pessoas veem esse nome quando são solicitadas a autorizar seu app.
- 3
Etapa 3 de 5
Adicione os escopos
Em Escopos, adicione cada permissão de que seu app precisa, uma de cada vez. Seu app só pode solicitar os escopos que você adicionar aqui. Veja a lista de escopos abaixo.
- 4
Etapa 4 de 5
Adicione as URIs de redirecionamento
Em URIs de Redirecionamento, adicione cada URL completa que seu app usa para receber respostas OAuth, por exemplo
https://app.example.com/oauth/callback. Seu app só pode usar as URIs que você adicionar aqui. Você pode pular esta etapa se o app só se comunicar com a API a partir de um servidor. - 5
Etapa 5 de 5
Crie o app e guarde o secret
Clique em Criar App.
Você verá:Uma janela de credenciais com seu Client ID e seu Client Secret.
Copie os dois e guarde-os em um lugar seguro imediatamente.
O client secret é mostrado apenas uma vez. Depois que você fecha a janela, a tabela mostra uma versão mascarada. Se você perder o secret, exclua o app e crie um novo.
Crie um app da conta
Acesse Conta › Apps e clique em Registrar App. Os campos e o secret exibido uma única vez funcionam da mesma forma que em um app do salão.
Escopos
Os escopos têm o formato area:action.
Adicione apenas os escopos de que seu app precisa.
Como obter tokens
Os apps aceitam estes tipos de concessão do OAuth 2.0:
- Client credentials, para acesso de servidor para servidor sem um usuário.
- Authorization code, quando uma pessoa entra e aprova seu app. Consulte Permita que um app acesse sua conta.
- Refresh token, para obter novos tokens de acesso sem pedir autorização de novo.
Quando seu app solicita um token, ele envia o client ID e o secret com autenticação HTTP Basic.
Edite ou exclua um app
Abra o menu do app na tabela:
- Atualizar altera o nome, os escopos ou as URIs de redirecionamento. O client ID e o secret continuam os mesmos.
- Excluir remove o app e as credenciais dele. Qualquer sistema que as use deixa de conseguir obter tokens.
Perguntas frequentes
Não. Ele só é mostrado quando o app é criado. Exclua o app e crie um novo para obter um novo secret.