Issue description  

ADManager Plus supports integration with external HCM, ITSM, SIEM applications and databases using APIs. This integration helps automate tasks in AD, such as user provisioning, deprovisioning, and updates, streamlining administrative processes and improving efficiency.

However, when attempting to integrate ADManager Plus with an external application, you may encounter the following error:

Response Status Code 500 or 400.

This error typically indicates a server-side issue that prevents the request from being processed successfully. Troubleshooting the API configuration and ensuring proper request formatting is essential to resolve the error and establish seamless integration.

Possible causes  

1. Incorrect API URL: The API request is being sent to an invalid or malformed URL.

2. Incorrect endpoint or parameters: The API endpoint or request parameters are incorrect, causing an internal error.

3. Authentication issues: Missing or incorrect API credentials (API key, token, etc.).

4. Firewall restrictions: The request is blocked due to security policies.

Prerequisites  

• Ensure you have API access credentials (API key, token, or authentication details).

• Verify the API documentation for the correct URL, endpoint, and parameters.

• Ensure that the external application is reachable from the ADManager Plus server.

Resolution  

Step 1: Verify the API URL  

1. Check if the API request is being sent to the correct base URL.

2. Compare your API URL with the official API documentation of the external application.

3. If unsure, try accessing the API URL directly in a web browser to check for errors (in case of a get call).
   

Step 2: Confirm the endpoint and parameters  

1. Cross-check the API endpoint in the external application’s documentation.

2. Ensure that the required parameters are correctly formatted.

3. If using JSON, validate the request body.

4. If using query parameters, ensure they are properly structured:

Example (correct format): https://api.example.com/v1/users?userId=12345

Step 3: Check authentication credentials  

1. If authentication is required, ensure the correct API key or token is used.
   
2. If using OAuth, confirm the token has not expired.

3. If using Basic Authentication, check that the credentials are correct.
   

Step 4: Test connectivity to the external API  

1. Use Postman or cURL to manually send a request and check for errors:

• curl -X GET "https://api.example.com/v1/users" -H "Authorization: Bearer <your_api_token>"

2. If you receive a 500 error, try sending a request with minimal parameters to see if the issue persists.

 Step 5: Firewall and security settings  

1. Ensure the external application’s API domain is allowed in the firewall settings.

2. Check network rules to verify outbound API requests are not blocked.

Tips 

• Always test API calls using Postman before integrating them into ADManager Plus.

• Check if the external API has any known downtime or issues.

• Enable logging to capture the API request and response details for debugging.

How to reach support