Documentação para Desenvolvedores

Usuário Autenticado

Informações do usuário

GET /api/v1/userinfo

Quando acessado através do OAuth2, as informações retornadas variam de acordo com as permissões concedidas pelo usuário conforme a tabela abaixo:

Quando acessado através do Token de Acesso, todass as informações são retornadas.

Escopo Campos Retornados
login [:login_url]
email [:email]
profile [:account_type, :first_name, :middle_name, :last_name, :full_name, :cpf, :date_of_birth, :mother_name, :father_name, :account_level]
address [:address_street_name, :address_number, :address_complement, :address_neighborhood, :address_postal_code, :address_city_name, :address_state]
phone [:phone_number]
business [:business_name, :business_cnpj, :business_legal_name]
balance [:balance_cents]

Exemplo

Requisição:
curl -i \
-u $BOLETOSIMPLES_TOKEN:x \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET 'https://sandbox.boletosimples.com.br/api/v1/userinfo'
Resposta:
HTTP/1.1 200 OK
Date: Fri, 17 Oct 2014 19:46:16 GMT
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

{
  "id": 53,
  "email": "meuecommerce@example.com",
  "account_type": "juridical",
  "sex": "female",
  "cpf": "142.578.243-44",
  "address_street_name": "Av. Burkhard Hehn Simões",
  "address_state": "RJ",
  "address_neighborhood": "São Francisco",
  "address_postal_code": "24360-440",
  "address_number": "120",
  "address_complement": "709",
  "phone_number": "2199999999",
  "withdrawal_period": "biweekly",
  "first_name": "Margret",
  "middle_name": "Simões",
  "last_name": "Gonçalo",
  "date_of_birth": "1970-03-01",
  "business_category": 1000,
  "business_subcategory": 2173,
  "business_website": "http://example.com.br",
  "business_name": "Sebastian Elias Publicidade",
  "business_legal_name": "Sebastian Elias Publicidade LTDA.",
  "business_type": "mei",
  "business_cnpj": "18.174.681/0001-70",
  "address_city_name": "Rio de Janeiro",
  "full_name": "Margret Simões Gonçalo",
  "login_url": "https://sandbox.boletosimples.com.br/welcome?email=meuecommerce%40example.com&token=UCefpzbGRrM1UrLEuUDS",
  "mother_name": "Lenadra Simões Gonçalo",
  "father_name": "José Simões Gonçalo",
  "balance_cents": "0",
  "account_level": "0"
}
Requisição:
@userinfo = BoletoSimples::Extra.userinfo
puts @userinfo
Resposta:
{
                      :id => 1,
               :login_url => "https://sandbox.boletosimples.com.br/welcome?email=user1%40example.com&token=xxx",
                   :email => "user@example.com",
            :account_type => nil,
              :first_name => nil,
             :middle_name => nil,
               :last_name => nil,
               :full_name => nil,
                     :cpf => nil,
           :date_of_birth => nil,
             :mother_name => nil,
             :father_name => nil,
           :account_level => 0,
            :phone_number => nil,
     :address_street_name => nil,
          :address_number => nil,
      :address_complement => nil,
    :address_neighborhood => nil,
     :address_postal_code => nil,
       :address_city_name => nil,
           :address_state => nil,
           :business_name => nil,
           :business_cnpj => nil,
     :business_legal_name => nil,
           :balance_cents => nil
}
Requisição:
$userinfo = BoletoSimples\Extra::userinfo();
print_r($userinfo);
Resposta:
Array
(
    [id] => 1
    [login_url] => https://sandbox.boletosimples.com.br/welcome?email=user1%40example.com&token=xxx
    [email] => user@example.com
    [account_type] =>
    [first_name] =>
    [middle_name] =>
    [last_name] =>
    [full_name] =>
    [cpf] =>
    [date_of_birth] =>
    [mother_name] =>
    [father_name] =>
    [account_level] => 0
    [phone_number] =>
    [address_street_name] =>
    [address_number] =>
    [address_complement] =>
    [address_neighborhood] =>
    [address_postal_code] =>
    [address_city_name] =>
    [address_state] =>
    [business_name] =>
    [business_cnpj] =>
    [business_legal_name] =>
    [balance_cents] =>
)