Signing In to the Developer Portal
Sign in with your RAZE account, choose External System, and use the Explanation guide and API reference to build each call.
Quick Reference
Go to api.getaraze.com and sign in with your RAZE email and password.
Choose Stage or Production at sign-in.
Under How are you connecting?, choose External System.
Use Explanation for the steps and Documentation for each call.
Before You Start
You have a RAZE account email and password with Developer Portal access.
Your institution keeps its projects in its own system.
Step 1 — Sign In
Open the Developer Portal
Go to api.getaraze.com. The sign-in page reads API Documentation.
Choose the environment and sign in
Pick Stage or Production, enter your email and password, and select Sign in. The password needs at least 6 characters.
Step 2 — Choose Your Connection Path
Choose External System
How are you connecting? offers two paths. Choose External System if you keep projects in your own system and only send and receive inspection data. Ordering Engine is for teams that create projects and order inside RAZE.
Picked the wrong path? Select Change connection at the top of the portal.
Step 3 — Read the Explanation Guide
Follow the four steps
Explanation opens the External System Integration guide. Its four steps are the order you build in: Get Authentication Token, Create Inspection, Check Status & Download Results (Polling), and Approve or Reject the Inspection.
This path doesn't use project creation or project search calls. The create call creates the project with its first inspection.
Step 4 — Use the API Reference
Open Documentation
Documentation is the RAZE API reference, grouped as Auth, Create Inspection, Check Status, Approve / Reject and Models. Each call shows its request, its responses and examples in Shell, Ruby, Node.js, PHP and Python.
Download the OpenAPI document
Select Download OpenAPI Document to load every call into your own tools. The reference is OpenAPI 3.0.3.
Tips
DO
- •Work through Explanation in order before you open single calls.
- •Use Search in the API reference to jump to a call.
- •Sign in to Stage while you build and test.
WATCH FOR
- •Choose External System, not Ordering Engine, when your projects live in your own system.
- •The portal sign-in is your own RAZE account; calls use the service account.
- •Use the Test Request button only with Stage credentials while you build.
Troubleshooting
Use this guide with AI.
Ask RAZE AI here, or hand the plain-text guide to the assistant you already use.
Was this guide helpful?
Still stuck? Ask RAZE.
Ask RAZE AI for an instant answer from these guides, or send a request and the RAZE support team replies by email.
Ask RAZE AI.
Instant answers from these guides, any time.
Send a support request.
Tell us the product and guide; the form is here.
Call or email.