Nibo Empresas API

API change history

C2 - Consulta clientes

C2 - Consulta clientes

Try it

Request

Solicitar URL

Parâmetros de solicitação

  • string

Corpo da solicitação

Responses

200 OK

OK

Representations

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "initialsName": "string",
      "email": "string",
      "phone": "string",
      "document": {
        "number": "string",
        "type": "string"
      },
      "communication": {
        "contactName": "string",
        "email": "string",
        "phone": "string",
        "cellPhone": "string",
        "webSite": "string"
      },
      "address": {
        "line1": "string",
        "line2": "string",
        "number": 0,
        "district": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "country": "string",
        "ibgeCode": "string"
      },
      "bankAccountInformation": {
        "bank": "string",
        "agency": "string",
        "accountNumber": "string"
      },
      "companyInformation": {
        "companyName": "string",
        "municipalInscription": "string"
      },
      "type": "string"
    }
  ],
  "nextPageLink": "string",
  "count": 0
}
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "initialsName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "communication": {
            "type": "object",
            "properties": {
              "contactName": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "cellPhone": {
                "type": "string"
              },
              "webSite": {
                "type": "string"
              }
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "number": {
                "format": "int32",
                "type": "integer"
              },
              "district": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "ibgeCode": {
                "type": "string"
              }
            }
          },
          "bankAccountInformation": {
            "type": "object",
            "properties": {
              "bank": {
                "type": "string"
              },
              "agency": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              }
            }
          },
          "companyInformation": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "municipalInscription": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "nextPageLink": {
      "type": "string"
    },
    "count": {
      "format": "int64",
      "type": "integer"
    }
  }
}
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "initialsName": "string",
      "email": "string",
      "phone": "string",
      "document": {
        "number": "string",
        "type": "string"
      },
      "communication": {
        "contactName": "string",
        "email": "string",
        "phone": "string",
        "cellPhone": "string",
        "webSite": "string"
      },
      "address": {
        "line1": "string",
        "line2": "string",
        "number": 0,
        "district": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "country": "string",
        "ibgeCode": "string"
      },
      "bankAccountInformation": {
        "bank": "string",
        "agency": "string",
        "accountNumber": "string"
      },
      "companyInformation": {
        "companyName": "string",
        "municipalInscription": "string"
      },
      "type": "string"
    }
  ],
  "nextPageLink": "string",
  "count": 0
}
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "initialsName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "communication": {
            "type": "object",
            "properties": {
              "contactName": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "cellPhone": {
                "type": "string"
              },
              "webSite": {
                "type": "string"
              }
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "number": {
                "format": "int32",
                "type": "integer"
              },
              "district": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "ibgeCode": {
                "type": "string"
              }
            }
          },
          "bankAccountInformation": {
            "type": "object",
            "properties": {
              "bank": {
                "type": "string"
              },
              "agency": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              }
            }
          },
          "companyInformation": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "municipalInscription": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "nextPageLink": {
      "type": "string"
    },
    "count": {
      "format": "int64",
      "type": "integer"
    }
  }
}
<PageResult_x005B_CustomerDto_x005D_>
  <items>
    <id>string</id>
    <name>string</name>
    <initialsName>string</initialsName>
    <email>string</email>
    <phone>string</phone>
    <document>
      <number>string</number>
      <type>string</type>
    </document>
    <communication>
      <contactName>string</contactName>
      <email>string</email>
      <phone>string</phone>
      <cellPhone>string</cellPhone>
      <webSite>string</webSite>
    </communication>
    <address>
      <line1>string</line1>
      <line2>string</line2>
      <number>0</number>
      <district>string</district>
      <city>string</city>
      <state>string</state>
      <zipCode>string</zipCode>
      <country>string</country>
      <ibgeCode>string</ibgeCode>
    </address>
    <bankAccountInformation>
      <bank>string</bank>
      <agency>string</agency>
      <accountNumber>string</accountNumber>
    </bankAccountInformation>
    <companyInformation>
      <companyName>string</companyName>
      <municipalInscription>string</municipalInscription>
    </companyInformation>
    <type>string</type>
  </items>
  <nextPageLink>string</nextPageLink>
  <count>0</count>
</PageResult_x005B_CustomerDto_x005D_>
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "initialsName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "communication": {
            "type": "object",
            "properties": {
              "contactName": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "cellPhone": {
                "type": "string"
              },
              "webSite": {
                "type": "string"
              }
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "number": {
                "format": "int32",
                "type": "integer"
              },
              "district": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "ibgeCode": {
                "type": "string"
              }
            }
          },
          "bankAccountInformation": {
            "type": "object",
            "properties": {
              "bank": {
                "type": "string"
              },
              "agency": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              }
            }
          },
          "companyInformation": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "municipalInscription": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "nextPageLink": {
      "type": "string"
    },
    "count": {
      "format": "int64",
      "type": "integer"
    }
  }
}
<PageResult_x005B_CustomerDto_x005D_>
  <items>
    <id>string</id>
    <name>string</name>
    <initialsName>string</initialsName>
    <email>string</email>
    <phone>string</phone>
    <document>
      <number>string</number>
      <type>string</type>
    </document>
    <communication>
      <contactName>string</contactName>
      <email>string</email>
      <phone>string</phone>
      <cellPhone>string</cellPhone>
      <webSite>string</webSite>
    </communication>
    <address>
      <line1>string</line1>
      <line2>string</line2>
      <number>0</number>
      <district>string</district>
      <city>string</city>
      <state>string</state>
      <zipCode>string</zipCode>
      <country>string</country>
      <ibgeCode>string</ibgeCode>
    </address>
    <bankAccountInformation>
      <bank>string</bank>
      <agency>string</agency>
      <accountNumber>string</accountNumber>
    </bankAccountInformation>
    <companyInformation>
      <companyName>string</companyName>
      <municipalInscription>string</municipalInscription>
    </companyInformation>
    <type>string</type>
  </items>
  <nextPageLink>string</nextPageLink>
  <count>0</count>
</PageResult_x005B_CustomerDto_x005D_>
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "initialsName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "communication": {
            "type": "object",
            "properties": {
              "contactName": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "cellPhone": {
                "type": "string"
              },
              "webSite": {
                "type": "string"
              }
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "number": {
                "format": "int32",
                "type": "integer"
              },
              "district": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "ibgeCode": {
                "type": "string"
              }
            }
          },
          "bankAccountInformation": {
            "type": "object",
            "properties": {
              "bank": {
                "type": "string"
              },
              "agency": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              }
            }
          },
          "companyInformation": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "municipalInscription": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "nextPageLink": {
      "type": "string"
    },
    "count": {
      "format": "int64",
      "type": "integer"
    }
  }
}
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "initialsName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "document": {
            "type": "object",
            "properties": {
              "number": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "communication": {
            "type": "object",
            "properties": {
              "contactName": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "cellPhone": {
                "type": "string"
              },
              "webSite": {
                "type": "string"
              }
            }
          },
          "address": {
            "type": "object",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "number": {
                "format": "int32",
                "type": "integer"
              },
              "district": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "country": {
                "type": "string"
              },
              "ibgeCode": {
                "type": "string"
              }
            }
          },
          "bankAccountInformation": {
            "type": "object",
            "properties": {
              "bank": {
                "type": "string"
              },
              "agency": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              }
            }
          },
          "companyInformation": {
            "type": "object",
            "properties": {
              "companyName": {
                "type": "string"
              },
              "municipalInscription": {
                "type": "string"
              }
            }
          },
          "type": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "nextPageLink": {
      "type": "string"
    },
    "count": {
      "format": "int64",
      "type": "integer"
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            var uri = "https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.nibo.com.br')
    conn.request("GET", "/empresas/v1/customers?Organization={Organization}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.nibo.com.br')
    conn.request("GET", "/empresas/v1/customers?Organization={Organization}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.nibo.com.br/empresas/v1/customers?Organization={Organization}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body