Default API and third-party
integrations offering

Which services are included and which are out of the default scope of work (this page was updated on 19 September 2022).

Intro

Intro

This document is created to present what's included in our standard API and third-party systems integration procedures. It aims to clearly define which services are included and which are out of the default scope of work.

We have several goals for the API and third-party systems integration procedure:

  • Ensure that the client understands the required effort that is needed to set third parties up and manage them.
  • Clearly define responsibility zones and requirements for successful integration.
  • Ensure that the system communicates with the other parties as it was designed.

To make this happen, we outline all required services, expectations, and deliverables.

We are happy to adjust those to the client's unique needs and guide them through technical difficulties. As those needs are mostly individual, we can estimate them precisely after several technical discovery sessions that need to happen in the first two weeks of our cooperation.

Services and Deliverables

Payment gateway setup

Our default payment gateway is Stripe. We prefer this provider because of the swiftness of integration and the ability to accept most payment methods.

Here are the requirements for the integration services rendering:

  • Stripe account should be set up by the client.
  • Client should pass the verification, AML, and KYC processes.
  • Client should set up all content that is needed to facilitate business processes, like subscriptions, invoicing, payouts, etc.
  • Client should invite a member of bn to the Stripe team with a Developer role.

If requirements are met, we provide the following services and deliver the subsequent outcomes:

  • We integrate the payment gateway per requirements on the code level based on the official documentation provided by the gateway.
  • We ensure proper data transfer between the system and the gateway in test mode.

The client gets:

  • Codebase that facilitates data transfer.
  • Secrets are managed the same way they are managed across the system.

Email provider setup

In case the system requires sending any emails, and there is a need to achieve that via the external system (like Mailgun, Mailchimp), we are ready to integrate it.

Here are the requirements for the integration services rendering:

  • Email delivery service account should be set by the client.
  • Client should pass the verification and any other processes to ensure the account is operating properly.
  • Client should ensure proper domain setup if it is not in the scope of the go-live procedures.
  • Client should share the access with a sufficient set of permissions and the required set of secrets with a member of bn.

If requirements are met, we provide the following services and deliver the subsequent outcomes:

  • We integrate the mail delivery system per requirements on the code level based on the official documentation provided by the mail delivery system.
  • We ensure proper email sending in test mode.

The client gets:

  • Codebase that facilitates data transfer between systems.
  • Secrets are managed the same way they are managed across the system.

Another third-party system setup

There is a wide range of third-party systems that we could integrate. Still, there are several rules of thumb that we need to follow while integrating those.

Here are the requirements for the integration services rendering:

  • The third-party system account should be set by the client.
  • Client should pass the verification and any other processes to ensure the account is operating properly.
  • Client should ensure proper third-party system setup if it is not in the scope of the go-live procedures.
  • Client should share the access with a sufficient set of permissions and the required set of secrets with a member of bn.

If requirements are met, we provide the following services and deliver the subsequent outcomes:

  • We integrate the third-party system per requirements on the code level based on the official documentation provided by the third-party system.
  • We ensure proper data transfer and interaction in test mode.

The client gets:

  • Codebase that facilitates data transfer between systems.
  • Secrets are managed the same way they are managed across the system.

nota bene

Things to keep in mind

  • The sole client is responsible for operating, managing, and controlling the external system after project handover.
  • BN Digital can not bear responsibility for the external system operations. This means if the external system misses SLA (like delivering emails, processing the payment, etc.), we will be unable to fix it on our side.
  • BN Digital can not bear responsibility for any changes in external system operations after the start of the integration process. This means if the external system changes its API, documentation, or the way it functions, all subsequent changes are subject to the additional scope of work.
  • The external system has its own restrictions that could impact designs and requirements for successful integration.
  • The external system has its own pricing and fee structure, and BN Digital does not bear responsibility for such payments or changes in terms.

We are happy to consult and help in setting up and configuring the external system on a consulting basis that is out of the default scope of work.

what's not included

  • bn's integrations related services
    • Third-party system possibilities research

    • Configuration consultations

    • Any form of documentation, guides, instructions

  • requirements documentation
    • Requirements and specifications

    • Any form of documentation, guides, instructions

process

Handover process

As we do not operate the third-party systems, we share the integration codebase as a part of the default delivery procedure. The client has the right to remove access of a bn member to all systems after the project handover.

Let’s work together.
We’d love to hear from you