Testing and Debugging

Use this page when a documented call does not behave the way you expect.

Debug Order

1. confirm chain type
2. confirm portal
3. confirm auth model
4. confirm required headers
5. confirm whether Secure Channel is required
6. confirm whether the endpoint is actually API-exposed

Web Chain Checklist

1. correct portal entrypoint
2. valid JWT if required
3. valid X-Client-Hash
4. valid X-SC-Session-Id if required
5. matching user role and portal permissions

API Chain Checklist

1. path starts with /api/v1/**
2. request is signed correctly
3. timestamp and nonce are valid
4. API key has the correct scope
5. endpoint supports API-key access

What To Capture In A Bug Report

1. exact path
2. chain type
3. portal
4. headers used
5. whether Secure Channel was active
6. HTTP status
7. public error code and message

Read Next

1. Error Model
2. the domain guide for the failing flow