Integration Checklist

Use this checklist to prepare your integration for development, testing, and go-live with the PAR OPS Back Office API.

1. Login and Integration Key

• Engage the PAR OPS support/partnership team to start the integration process.
• Create a login (if you have permissions) or ask support to create and configure one for you.
• Obtain a DCKey (Integration Key) from the PAR OPS support team for your application.
• Confirm which environment(s) you have access to (e.g., sandbox/test vs. production).

2. Technical Prerequisites

• Confirm the base URL(s) for the environment(s) you will call, including the port number assigned to your organization.
• Confirm that your integration authenticates using the DCKey header only.
• Implement secure storage for the DCKey (no hardcoding in source control, no exposure in client-side code).

3. API Coverage

• Identify which API you need: v1 (legacy), v2+ (current, recommended for new integrations), and/or ShiftWorks (employee-facing scheduling).
• Review the endpoint groups relevant to your use case in the API References section.
• Confirm that your DCKey has permission for the endpoint groups you plan to call (coordinate with PAR OPS support if you receive unexpected 401 Unauthorized or 403 Forbidden responses).

4. Testing

• Test behavior when the DCKey is missing or invalid.
• Confirm that your account has the correct permissions/scope for the endpoints you call.
• Validate error handling for 4xx client errors (e.g., 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found) and 500 Internal Server Error responses.
• Check your integration's call patterns against rate limits in non-production environments before go-live, and confirm that your integration handles rate-limit (429 Too Many Requests) responses gracefully.

5. Go-Live

• Confirm that production DCKey and credentials are provisioned and scoped correctly.
• Confirm a support/escalation contact at PAR OPS for production incidents.
• Review logging/monitoring on your side to detect authentication failures or elevated error rates after launch.

Need Help?

Contact the PAR OPS support/partnership team for DCKey provisioning, environment URLs, and permission scoping questions not covered in this portal.