What info require from client to setup ebonding in REST API

mania
Tera Contributor

4 weeks ago

Hi,

I am learning integration concepts so here i am having one doubt here

what is the common information we need from the client to setup the eBonding (REST API)

Can anyone please help on this, it will be grate for my learnings?

Thanks!

0 Helpfuls
  • 192 Views
2 REPLIES 2

Chaitanya ILCR
Mega Patron

4 weeks ago - last edited 4 weeks ago

Hi @mania ,

You ask for below details

 

 

1. API Endpoint Details

  • Base URL of the external system’s REST API

  • Specific resource paths (e.g., /incident, /change, etc.)

2. Authentication Information

  • Type of authentication (Basic Auth, OAuth 2.0, API Key, etc.)

  • Credentials or tokens required for access

  • Token refresh mechanism (if applicable)

3. Data Format and Structure

  • Expected request and response formats (usually JSON or XML)

  • Field mappings between systems (e.g., short_description in ServiceNow ↔ summary in external system)

  • Required and optional fields

4. Integration Use Cases

  • What data needs to be exchanged (Incidents, Changes, Tasks, etc.)

  • Direction of data flow (uni-directional or bi-directional)

  • Trigger conditions (e.g., on create/update/close)

5. Security and Access Control

  • IP whitelisting or firewall rules

  • SSL certificates (if mutual TLS is used)

  • Access Control Lists (ACLs) or roles required

6. Error Handling and Logging

  • Expected error codes and messages

  • Retry logic and failure handling

  • Logging requirements for audit and debugging

7. Testing and Sandbox Environment

  • Availability of a test or staging environment

  • Sample payloads for testing

  • Contact points for troubleshooting

 

Please mark my answer as helpful/correct if it resolves your query.

Regards,
Chaitanya

0 Helpfuls