Guia Rápido

Como autenticar na API do Ellos

As APIs disponibilizadas pela plataforma utilizam o protocolo Bearer Token para realizar a autenticação e autorização de acesso das APIs. Siga os passos abaixo para se autenticar e consumir a API.

Solicite o Bearer Token

Para consultar as APIs, é necessário obter um token de acesso temporário (Bearer). Esse token possui um tempo de validade e sempre que expirado, este passo de requisição de um novo token de acesso deve ser repetido.

Como solicitar o Token de Acesso (Bearer)

Para solicitar o token temporário é necessário realizar uma requisição HTTP POST para o endpoint https://api.hom.ellos.org.br/ellos/associate/api/Associate/login.

Fornecendo o email e a senha, faça a requisição a API.

                            
                                curl -X POST "https://api.hom.ellos.org.br/ellos/associate/api/Associate/login"\
                                -H "accept: application/json" \
                                -H "Authorization: Bearer eyJraWQiOiI4aTV5cndFMVlreGc4M0FWXC9MTWFacHk0b0J0TEJ6a01yN21" \
                            
                        

No exemplo acima foram utilizados os seguintes parâmetros:

• [HEADER] Accept: application/json
  Informamos o tipo de dados que estamos requerendo, nesse caso JSON

• [HEADER] Authorization: Bearer eyJraWQiOiI4aTV5cndFMVlreGc4M0FWXC9MTWFacHk0b0J0TEJ6a01yN21 Informamos o token de acesso recebido

• [POST] https://api.hom.ellos.org.br/ellos/associate/api/Associate/login

Exemplo de requisição esperada:

                            
                                {
                                    "email": "yourEmail.com"
                                    "password": "Your Name",
                                }
                            
                        

Exemplo de resposta esperada:

                            
                                {
                                    "success": true,
                                    "data": {
                                        "email": "yourEmail.com",
                                        "name": "YourName",
                                        "token": "eyJraWQiOiI3YkFrTDJsdEhDMVhDcUNIpWRxcHVoTUFsWDBZVWdCXC9QSllNcTdQNkpSbz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhYTI2MDU2MC1hYTRmLTRhY2QtYmQ0ZS1iYTI1YjJjN2YzNjkiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfQ09iVXJKaVhKIiwiY29nbml0bzp1c2VybmFtZSI6Inlnb3IubGltYUBwcHByby5jb20uYnIiLCJhdWQiOiI0YXF1YW0xdHFvajFmdHA5aDc5dnVtc2ppYSIsImV2ZW50X2lkIjoiMGI2Y2ExM2EtMDY3NC00ZmRkLWIzZmEtNDVlNzRjZWUxMTUwIiwidG9rZW5fdXNlIjoiaWQiLCJhdXRoX3RpbWUiOjE3NDgyNjg1OTIsIm5hbWUiOiJZZ29yIFNhbnRvcyBEZSBMaW1hIiwiZXhwIjoxNzQ4MjcyMTkyLCJpYXQiOjE3NDgyNjg1OTIsImVtYWlsIjoieWdvci5saW1hQHBwcHJvLmNvbS5iciJ9.HfiZI2O8Oojix7dK101lBBSwH56dQmPkgeqJopQHkN7NEHvs-0YcSOgvYEXgH2E36eepPBI_WWvPJqcvyYn_iMQLSQscG3uWnw5oP72_toWhL3cX6MMZabVRiJvGJe7XoezmKUOczSEcLxa4Yj8ZIfMkI6PAz2bZUaDgNoSr2gDOiBhxkdbjevt2xrL27YUryD7NBv41Elmi7Ehz_KgdG7L-zPE3_SI8nPc9JLZxxEbvDbPAHM3rgXyvoqACC2TrpQnPKXF83mVL4DoSVDO488ca2ghrp-36TGbbG7G_95k1LfoZzuLozrSX0lxP9T_7C9xVKEoW6M5lICo3MpYf7Q",
                                        "profilePicture": null,
                                        "refreshToken": "eWdvci5saW1hQHBwcHJvLmNvbS5iciwgSnkwMjAxMTk8Mw=="
                                    },
                                    "errors": null
                                }