Hello! This page will be helpful to you if you’re Barchart employee or an ERP partner that we’re just starting to work with. Let’s go through the different progressions we’ll work through together.
Getting Started
Discovery
This is the getting to know you phase. Generally we’re going to want to ask the following questions to better understand your capabiliities.
General data access:
How do you typically deliver this type of data (Contracts, Customers, Settlements and Balances) outside of your ERP system?
Do you have an API for 3rd party integrations?
Is your API REST based? JSON or XML output format?
Maybe flat files via SFTP?
Do you have documentation available on this API?
Do you have a sandbox/testing environment available for development?
Webhooks (HTTP POST) Integration:
Do you support a push (HTTP POST) style delivery mechanism (e.g. on data changes they would send us updates)?
Have you seen our sample data models?
Do they have technical questions or need access to a sandbox for this type of integration? Contact marketplace@barchart.com.
Follow-up
After the Discovery emails / calls we’ll follow-up with some more detail on how we can start working together. Here’s an example of what we might send to you . The relevant attachments are below the code snippet
Hi [Provider], Thanks for the call today. Attached is a brief rundown of the ingestion interface on our side - also attached are some example JSON models. Here is a Postman example of the Update API (HTTP POST): https://documenter.getpostman.com/view/4988380/TVYNXuxD Update HTTP Endpoint https://gar.aws.barchart.com/api/v1/providers/[Provider]/update API Key [Insert any GUID from here (and save it somewehre): https://www.guidgenerator.com/] Example CURL curl --request POST 'https://gar.aws.barchart.com/api/v1/providers/[Provider]/update' \ --header 'x-api-key: [GUID]' \ --header 'x-customer-context: an-elevator-company' \ --header 'Content-Type: application/json' \ --data-raw '{ "key": "any JSON body format is accepted" }' To start, the API will just echo back what you POST to it, once we have the official JSON structure for your document entities we can start the indexing process on our side. Any questions just let us know. [Attach barchart_models.zip] [Attach Accounting_Ingestion.pdf]
Ingestion Examples