Receitaws.API.Client 1.0.0

Receitaws .NET API Client

This is a .NET client implementation of the receitaws api that gives you data of brazilian companies and enterprises.

You can use the receitaws's API for free, some endpoints doesnt need authentication, and the ones that does you can register on their website for free. You just need to login on the account, go to the API section and generate a token to use.

Packages

Package	Version	Downloads	Workflow
Receitaws.API.Client
Receitaws.API.Client.DependencyInjection

Endpoints

1. FindByCnpj: Find a company by its CNPJ number;

var company = await client.LegalEntity.FindByCnpj(cnpj);

2. FindByCnpj with precision: Find a company by its CNPJ number with days precision of the data;

Note: You must be authenticated to use this endpoint

var company = await client.LegalEntity.FindByCnpj(cnpj, days);

Note: This endpoint is not free, is going to discount of your avaliable quote quantity.

3. GetAccountProfile: Get informations about your receitaws's account, basically the quotes remaining quantity.

Note: You must be authenticated to use this endpoint

var accountProfile = await client.Account.GetAccountProfile();

4. GetAccountHistoricReport: Get a historic report of the APIs calls that used your quotes, the calls that costed quotes.

Note: You must be authenticated to use this endpoint

var accountHistoricReport = await client.Account.GetAccountHistoricReport();

Configuration

This Api integration is ver simple, there is no authentication/authorization requirements, you can use it with almost no configurations.

You can instanciate this client in three different ways:

1. Using default configs: This uses the default baseUrl, timeout and Throw on any error flag.

Note: This default setup is without token, so you can only access the method <b>FindByCnpj</b> because is the only >one that doesnt need authentication.

var client = new Receitaws();

or by dependency injection:

services.AddReceitawsApiClient();

2. Only configurating the token:

var client = new Receitaws(token);

or by dependency injection:

services.AddReceitawsApiClient(token);

3. And setup manually all configurations with your preferences:

var configs = new ReceitawsApiClientConfiguration 
{
    Token  = "YOUR_API_TOKEN",
    BaseUrl = baseUrl,
    MaxTimeout = 10000,
    ThrowOnAnyError = false
};

var client = new Receitaws(configs);

or by dependency injection:

var configs = new ReceitawsApiClientConfiguration 
{
    Token  = "YOUR_API_TOKEN",
    BaseUrl = baseUrl,
    MaxTimeout = 10000,
    ThrowOnAnyError = false
};

services.AddReceitawsApiClient(configs);