API OpenFinTech.io

Conheça a plataforma

O que integrar com OpenFinTech.io

Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.

Introduction OpenFinTech.io is an open database that comprises of standardized primary data for FinTech industry. It contains such information as geolocation data (countries, cities, regions), organizations, currencies (national, digital, virtual, crypto), banks, digital exchangers, payment providers (PSP), payment methods, etc. It is created for communication of cross-integrated micro-services on "one language". This is achieved through standardization of entity identifiers that are used to exchange information among different services. UML UML Domain Model diagram you can find here. Persistence Entities are updated not more than 1 time per day. Terms and Conditions This *OpenFinTech.io* is made available under the Open Database License. Any rights in individual contents of the database are licensed under the Database Contents License. Contacts For any questions, please email - [email protected] Or you can contact us at Gitter Powered by Paymaxi Get Started If you use POSTMAN or similar program which can operate with swaggers files - just download our spec and import it. Also you can try live API demo. Overview The OpenFinTech API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. API is based on JSON API standard. JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects. JSON API requires use of the JSON API media type (application/vnd.api+json) for exchanging data. Additional Request Headers ACCEPT HEADER Your requests should always include the header: curl Accept: application/vnd.api+json Authentication To use OpenFinTech API no needed authorization. Versioning When we make changes to the API, we release new, dated versions. The current version is 2017-08-24. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility. Pagination OpenFinTech APIs to retrieve lists of banks, currencies and other resources - paginated to 100 items by default. The pagination information will be included in the list API response under the node name meta - contains information about listed objects [total - contains information about total count of listed objects, pages - count of pages], links - contain links to navigate between pages [first - link to first page, prev - link to previous page, next - link to next page, last - link to last page]. By default first page will be listed. For navigating through pages, use the page parameter (e.g. page[number], page[size]). The page[size] parameter can be used to set the number of records that you want to receive in the response. The page[number] parameter can be used to set needed page number. Example of response: json { "meta": { "total": 419, "pages": 42 }, "links": { "first": "/v1/{path}?page[number]=1&page[size]=10", "prev": "/v1/{path}?page[number]=39&page[size]=10", "next": "/v1/{path}?page[number]=41&page[size]=10", "last": "/v1/{path}?page[number]=42&page[size]=10" } Sorting OpenFinTech\s API supported query parameter to sort result collection [e.g. ?sort=code]. Information about available parameters may be found in the endpoint description. Positive parameter [e.g. ?sort=code] points to ascending sorting, negative [e.g. ?sort=-code] - to descending sorting. Also, supported multiple sorting parameters [e.g. ?sort=code, -name, id, etc.] curl https://api.openfintech.io/v1/countries?sort=name,-area Filtering Filtering provided by unique query key filter[*filtering_condition*]. Information about available parameters may be found in the endpoint description. curl https://api.openfintech.io/v1/countries?filter[region]=europe Images OpenFinTech provides two types of images: icons and logos. To get one of those types you should to use next url pattern: curl https://api.openfintech.io/v1/{path}/{id}/{icon/logo} Also, images can be resized by adding next parameters: h={height}&w={width}. For example, you want to get organization icon with width equals to 20 pixels: curl https://api.openfintech.io/v1/organizations/{id}/icon?w=20&h=20 If argument height or width is missing API returns original image with real sizes. Errors API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with OpenFinTech's servers (these are rare). | Code | Description | |------|-------------| | 200 - OK | Everything worked as expected. | | 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. | | 401 - Unauthorized | No valid API key provided. | | 402 - Request Failed | The parameters were valid but the request failed. | | 404 - Not Found | The requested resource doesn't exist. | | 409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). | | 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. | | 500, 502, 503, 504 - Server Errors | Something went wrong on OpenFinTech's end. (These are rare.) |

Do planejamento à produção

Checklist para integrar OpenFinTech.io

1. Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
2. Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
3. Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
4. Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
5. Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
6. Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.