Aplicações

GET /applications/api/

  • Lista todas as aplicações habilitadas.
  • Autenticação utilizando token e secret da aplicação.

  • As informações de paginação são incluidas no header Link de cada resposta, conforme necessário, como exemplificado abaixo:

    Link: <https://app.passaporteweb.com.br/applications/api/?page=3&limit=1>; rel=next,
    <https://app.passaporteweb.com.br/applications/api/?page=1&limit=1>; rel=prev,
    <https://app.passaporteweb.com.br/applications/api/?page=3&limit=1>; rel=last,
    <https://app.passaporteweb.com.br/applications/api/?page=1&limit=1>; rel=first
Código de retorno Descrição
200 OK Operação completada com sucesso
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação). Aplicação não autorizada para esta operação.
404 Not Found O número da página solicitada não existe
500 Internal Server Error Erro interno do Passaporte Web

Exemplo (informações somente ilustrativas):

GET https://app.passaporteweb.com.br/applications/api/
Accept-Encoding: gzip, deflate
Cache-Control: no-cache
Content-Type: application/json
Accept: application/json
Authorization: Basic amtBS1sOUsxndgpHUGp6elpac8U3dnNRUWl6WmtceFZG9kxjelK0dNNTZg==

[
    {
        "account": "740d0256-9062-4824-ab96-efabcbe36ca1",
        "name": "MyFinance",
        "color": "#13325d",
        "icon_url": "https://res.cloudinary.com/passaporte-web/image/upload/v1/applications/myfinance/icon",
        "text_color": "#ffffff",
        "instances": [{
            "sso_url": "https://myfinance.com.br/auth/passaporte_web",
            "description": "Myfinance",
            "label": "MyFinance"
        }],
        "url": "https://app.passaporteweb.com.br/applications/api/myfinance/",
        "active": true,
        "logo_url": "https://s3.amazonaws.com/myfreecomm-assets/logo-myfinance.png",
        "slug": "myfinance"
    },
    {
        "account": "f0d83de7-7937-40d9-aa05-bfba72e2ccca",
        "name": "Passaporte Web",
        "color": "#2E3035",
        "icon_url": "https://app.passaporteweb.com.br/static/img/ico-passaporte-login.png",
        "text_color": "#FFFFFF",
        "instances": [{
            "sso_url": "https://app.passaporteweb.com.br/admin/",
            "description": "Administração Passaporte Web",
            "label": "Administração"
        }],
        "url": "https://app.passaporteweb.com.br/applications/api/passaporte-web/",
        "active": true,
        "logo_url": "https://app.passaporteweb.com.br/static/img/logo-passaporteweb-oauth.png",
        "slug": "passaporte-web"
    }
]

GET /appplications/api/:slug/

  • Obtém detalhes de uma aplicação.
  • Não recebe parâmetros.
  • Autenticação utilizando token e secret da aplicação.
Código de retorno Descrição
200 OK Operação completada com sucesso
401 Unauthorized Credenciais não informadas ou inválidas
403 Forbidden Credenciais informadas são inválidas para este recurso (ex: token/secret da aplicação). Aplicação não autorizada para esta operação.
404 Not Found Não existe aplicação identificável pelo slug fornecido
500 Internal Server Error Erro interno do Passaporte Web

Exemplo (informações somente ilustrativas):

GET https://app.passaporteweb.com.br/applications/api/passaporte-web/
Accept-Encoding: gzip, deflate
Cache-Control: no-cache
Content-Type: application/json
Accept: application/json
Authorization: Basic amtBS1sOUsxndgpHUGp6elpac8U3dnNRUWl6WmtceFZG9kxjelK0dNNTZg==

{
    "account": "f0d83de7-7937-40d9-aa05-bfba72e2ccca",
    "name": "Passaporte Web",
    "color": "#2E3035",
    "icon_url": "https://app.passaporteweb.com.br/static/img/ico-passaporte-login.png",
    "text_color": "#FFFFFF",
    "instances": [{
        "sso_url": "https://app.passaporteweb.com.br/admin/",
        "description": "Administração Passaporte Web",
        "label": "Administração"
    }],
    "url": "https://app.passaporteweb.com.br/applications/api/passaporte-web/",
    "active": true,
    "logo_url": "https://app.passaporteweb.com.br/static/img/logo-passaporteweb-oauth.png",
    "slug": "passaporte-web"
}