Get started

    API Endpoint
    
    

Para consumir a API, basta fazer a requisição para os endpoints com os Verbos indicados na documentação, Atenção Token gerado no login expira em 1 hora.

Caso tenha dúvidas na API. Por favor entrar em contato com: [email protected] Com o título "API GLOBAL SERVICE".

Se precisar gerar um token de Cartão de Crédito para testes: Página de Gerar Token

Login

    
    # Exemplo de Requisição em PHP
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "http://{URL Server}/api/auth/login",
        CURLOPT_RETURNTRANSFER       => true,
        CURLOPT_ENCODING             => "",
        CURLOPT_MAXREDIRS            => 10,
        CURLOPT_TIMEOUT              => 0,
        CURLOPT_FOLLOWLOCATION       => true,
        CURLOPT_HTTP_VERSION         => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST        => "POST",
        CURLOPT_POSTFIELDS => array(
            'document_number'  => '{cpf/cnpj}',
            'password'         => '{senha}'
        ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    

(POST) A URL de requisição para está ação é :
https://gateway.federalassociados.com.br/api/auth/login

    
    Resultado Esperado :
    {
        code: 50000,
        status: "success",
        message: "Logado com sucesso!",
        data: {
            access_token: "{token}",
            token_type: "bearer",
            expires_in: 3600
        },
        url: "panel.main.index"
    }
    
    

Parâmetros para esta requisição

Deslogar

    
    # Exemplo de Requisição em PHP
    $curl = curl_init();
        curl_setopt_array($curl, array(
        CURLOPT_URL => "http://{URL Server}/api/auth/logout",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_HTTPHEADER => array(
            "Authorization: Bearer {token}"
        ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    

(POST) A URL de requisição para está ação é :
https://gateway.federalassociados.com.br/api/auth/logout

    
    Resultado Esperado :

    {
        code: 10001,
        status: "success",
        message: "Deslogado com Sucesso!!",
        data: null,
        url: "panel.main.index"
    }
    
    

Parâmetros para esta requisição

Renovar Token

    
    # Exemplo de Requisição em PHP
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "http://{URL Server}/api/auth/refresh",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_ENCODING => "",
      CURLOPT_MAXREDIRS => 10,
      CURLOPT_TIMEOUT => 0,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer {token}"
      ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    

(POST) A URL de requisição para está ação é :
https://gateway.federalassociados.com.br/api/auth/refresh

    
    Resultado Esperado :

    {
        code: 50000,
        status: "success",
        message: "Logado com sucesso!",
        data: {
            access_token: "{token}",
            token_type: "bearer",
            expires_in: 3600
        },
        url: "panel.main.index"
    }
    
    

Parâmetros para esta requisição

Retornos de Erros

Atenção aos códigos de retorno de erros: