Article 675: Key Points to Discuss When Talking About CORE/REST API with a Prospective Customer

Customer Needs to Code the Connection:
Customers are responsible for coding the connection to our API. They should have a qualified developer or development team on their side to handle this task. We provide comprehensive documentation to assist them, but how they form and send the API requests, as well as the source of the data they use in their payloads, is entirely their responsibility.
Assistance with Errors:
If the customer encounters errors while sending API requests, we can assist by reviewing the full payload they are sending. Based on the payload, we will identify and advise on issues in their code that need to be corrected for successful communication with the API.

Enabling the CORE API Functionality in the Webship System:
Ensuring that the CORE API functionality is activated and available for use by the customer in their system.
Providing Documentation:
Delivering comprehensive and clear documentation for our API, including endpoint details, expected request/response structures, authentication methods, and examples of valid payloads.
Reviewing API Errors:
When customers send requests to our API and encounter errors, we are responsible for reviewing the error logs or payloads. We can provide insights and guidance on what specific issues are causing the errors and how they can be corrected on the customer's side.

Coding the Connection:
We do not handle coding the connection between the customer's system and our API. This is the responsibility of the customer’s technical team.
Advising on API Request Formation:
We do not guide customers on the specifics of how to form or send their API requests beyond the general guidelines outlined in the documentation.
Customer’s External Systems:
We do not provide technical advice on the customer’s external systems, such as how their software or infrastructure works or what is technically feasible within their codeset.
Debugging or Troubleshooting Customer Code:
We do not debug or write code for the customer, although we can review and advise based on payload errors.

Communicating with the Customer:
Partners act as intermediaries, ensuring the customer has access to documentation and knows what is required to connect to the API. They should also assist in managing expectations regarding responsibilities for development and troubleshooting.
Gathering Relevant Information:
Partners should help collect all necessary details from the customer, such as full payloads and error messages, before escalating issues to us for review.
CORE API Fee

Providing Development Resources:
Customers must ensure they have a developer or technical team capable of coding the API connection and maintaining it over time.
Forming and Sending Requests:
Customers are responsible for forming valid API requests, sending them correctly, and troubleshooting their code if issues arise.
Providing Full Context for Error Review:
When requesting assistance with errors, customers need to supply full details, such as the complete payload being sent, error messages received, and any relevant logs or context.
Maintaining Their External Systems:
Customers are responsible for ensuring their external systems are capable of generating valid API requests and handling the data received in the API response.