Need Advice on Integration using REST API Best Practice

Ziad Qadora
Kilo Sage

Hello,

We have a requirement to allow case creation via REST API.  I have been trying to determine the current best practice for such integration.  I'm aware that there is an OOB case Scripted REST API that we can use for the integration. 

But since this is new development and our case creation requires a lot more fields than what is required when creating a case OOB. I'm leaning to develop the integration using the integration hub, but wanted to get the current recommended best practice.

If using the integration hub is not the recommended current best practice, then what is recommended.

If any one has done an integration to create case, then any additional useful info would be highly appreciated.

Regards,

Ziad

1 ACCEPTED SOLUTION

Community Alums
Not applicable

Hi Ziad Qadora,

I would encourage to go through the docs and few videos around it

5 Common Mistakes When Integrating ServiceNow and How to Avoid Them

Tips for writing integrations

INTEGRATION BEST PRACTICES – INBOUND WEB SERVICES

Integration Best Practices - Outbound Web Service - YouTube

 

For for Authentication:

1) Basic authentication - username and password Where you can create user, give web_services, rest_service, soap related roles So you can use the same user for all your integrations and this is what we used to do. 2) Outh authentication - it is more secured 3) no authentication - where you can use the API key as header Ex- API key is a 32/40 string value and used for authentication this needs to be used in the header In Azure integration we have used header as application bearer [api-key] and that gives us an token in response. For any further API calls if we have to use then we should use the token which generated and that token is valid for 1 hour (can set to any value) .

 

Hope this covers everything.

Please mark my answer as Correct & Helpful, if applicable.

Thanks

Sandeep

View solution in original post

1 REPLY 1

Community Alums
Not applicable

Hi Ziad Qadora,

I would encourage to go through the docs and few videos around it

5 Common Mistakes When Integrating ServiceNow and How to Avoid Them

Tips for writing integrations

INTEGRATION BEST PRACTICES – INBOUND WEB SERVICES

Integration Best Practices - Outbound Web Service - YouTube

 

For for Authentication:

1) Basic authentication - username and password Where you can create user, give web_services, rest_service, soap related roles So you can use the same user for all your integrations and this is what we used to do. 2) Outh authentication - it is more secured 3) no authentication - where you can use the API key as header Ex- API key is a 32/40 string value and used for authentication this needs to be used in the header In Azure integration we have used header as application bearer [api-key] and that gives us an token in response. For any further API calls if we have to use then we should use the token which generated and that token is valid for 1 hour (can set to any value) .

 

Hope this covers everything.

Please mark my answer as Correct & Helpful, if applicable.

Thanks

Sandeep