Production Access Request Criteria

  • 2
  • Article
  • Updated 2 years ago
  • (Edited)
RingCentral has implemented a set of criteria we use in order to have mutual confidence of performance and stability of the apps/integrations requesting Production API Keys (Production Access).

This is why the Sandbox environment/account exists, as it is the place for you to develop your app/integration as you would in production (without the risk or impact of damaging your production RingCentral account and data).

Production Access Minimum Requirement Criteria
  1. Has the app/integration owner provided a complete and detailed description and use-case summary?

  2. Apps are required to make a minimum of 5+ API calls per each used endpoint (20+ in total)


    Your app should send at least 5 successful ( 2xx ) requests to each of the endpoints it uses while the overall number of successful requests (2xx response) should not be less than 20. OAuth 2.0 requests do not count

  3. There should not be any unused API permissions added to your app. Your app should “Exercise all the requested permissions"

    Example: Your app should be making the relevant API requests using all your app permissions. NOTE: If you are not making use of certain permissions, you may remove them or reply to this email with the permissions you do not need and we will remove them on your behalf and re-evaluate your app for graduation.

  4. Your app should have less than 5% of 4xx errors out of total API calls amount during the last two days ( UTC timezone ) and not exceed the RingCentral API throttling limits.

    Example: Your app/integration should not have received one or more HTTP 429 responses – Too many request error (https://devcommunity.ringcentral.com/ringcentraldev/topics/429-too-many-requests-error )

  5. Your should be properly using the access and refresh tokens
    (https://devcommunity.ringcentral.com/ringcentraldev/topics/generating-access-token-and-refresh-token-and-efficiently-using-them )
Photo of Benjamin Dean

Benjamin Dean

  • 8,582 Points 5k badge 2x thumb

Posted 2 years ago

  • 2
Photo of Allivet Smith

Allivet Smith

  • 120 Points 100 badge 2x thumb
I think we are ready to move to production, however the button "Apply for Production" remains disabled, basically the only thing we need to do is renew the access token when expired, read the inbox messages and download any pdf there, then delete that message.

Today I have been testing, however any of the request done today are showing up in the chart. What can I do please. Last time happened same thing it only displayed the first 2 days but the next days stopped showing. Then I had to start a different project so I stopped to test "Rest API integration" for two weeks.

So three days ago I was able to resume the "REST API integration" and happened same thing, now it is only showing the first two days testing. Today nothing is showing.
Photo of Benjamin Dean

Benjamin Dean

  • 8,582 Points 5k badge 2x thumb
Hey Allivet,

So there are two issues you need help with:

1. Apply for Production button is disabled
2. The most recent API request data is missing from the charts of the Analytics portion of Developer Portal for my application.

I will answer these, but if I have missed anything, please feel free to add/respond.

1. Apply for Production button is disabled
The RingCentral Developer Portal has an un-named feature we call "The Developer Journey". The core components of this feature are: API analytics for your app, our Production Access Criteria Rules, and the UI to empower you with the status of your application as it relates to our rules and your API usage. You can access this feature by doing the following:

  1. Login to the RingCentral Developer Portal
  2. From the main navigation, hover over "MyApps", and select your application from the list (or click "See All Apps" to view the entire list if you do not see your app in the quick pick list).
  3. The Dashboard view of your Application page in Developer Portal contains a well named Production Status. The content in this well provide you, the developer, with a quick pulse on where your application is in the development process as it relates to Production access. There is a link titled "graduation requirements" you can click to view the status of your application as it relates to our Production Access Criteria Rules (the "graduation requirements" link points to the "Status & Review" section of Developer Portal for your application, which is explained in the next step).
  4. You can see a more detailed view of your the Status & Review of your Application (where the graduation requirements link of #3 above is referenced). Click on Status & Review.
  5. This page contains two sections: Production Status (same from Dashboard view), and the Graduation Requirements section. This section provides you with a detailed list of our Production Access Criteria, and how it relates to the current state of your application towards being approved for Production Access. If the button named "Apply for Production" is greyed out it is because your application is failing to meet one of our Production Access Criteria.
  6. Please review the 'error state' of each rule that is failing and resolve the issue within your application code or your application's definition in Developer Portal as indicated.
  7. Note that the data in this view may be cached, but there is a 'refresh' icon you can use to update the state of the review data.
  8. If you feel that your application has met all of the rules, but you are still unable to "Apply for Production", please submit a Developer Support Case.
  9. We process requests for production each workday and address all requests from the previous day(s).
2. The most recent API request data is missing from in the charts of the Analytics portion of Developer Portal for my application.

The Analytics charts in Developer Portal are a tool to empower developers with the information they need about how their applications are operating with the RingCentral API. There are two primary views of Analytics data charts  based on the environment of the data being reported: Sandbox and Production (note that if your application has not applied for and been granted Production access, there will be zero data in the Production views for your application). There are several data views and filters for these views available from within the Analytics section of each application you have defined in the Developer Portal.

Analytics Data Views Available in the Developer Portal for Each Application
  • API Calls: Provides developers with an aggregated count of all API requests for your application

    - Past 30 Days Filter: Provides you with a daily aggregate of all requests for your application over the past 30 days
    - Past 7 Days Filter: Provides you with a daily aggregate of all requests for your application over the past 7 days
    - Past 24 Hours Filter: Provides you with an hourly aggregate of all requests for your application over the past 24 hours
      (note, that does not === TODAY, but actually the past 24 hours)

  • Endpoints: Provides developers with aggregated counts of API requests grouped by the path of the API request sent by your application

    - Past 7 Days Filter: Provides you with a daily aggregate counts of API requests grouped by the path of the API request sent by your application for the past 7 days
    - Past 24 Hours Filter: Provides you with hourly aggregate counts of API requests grouped by the path of the API request sent by your application for the past  24 hours
      (note, that does not === TODAY, but actually the past 24 hours)

  • Permissions: Provides developers with aggregated API request counts based on the associated API permission required to execute the request

    - Past 7 Days Filter: Provides you with aggregated API request counts based on the associated API permission required to execute the request for the past 7 days
    - Past 24 Hours Filter: Provides you with aggregated API request counts based on the associated API permission required to execute the request for the past  24 hours
      (note, that does not === TODAY, but actually the past 24 hours)

  • Response Times: Provides developers with visibility into the performance of RingCentral's processing and responding to the API requests for your application

    - Past 7 Days Filter: Provides developers with visibility into the performance of RingCentral's processing and responding to the API requests for your application for the past 7 days
    - Past 24 Hours Filter: Provides developers with visibility into the performance of RingCentral's processing and responding to the API requests for your application for the past  24 hours
      (note, that does not === TODAY, but actually the past 24 hours)
If you are not seeing the data for your most recent API requests, try switching the filter to "Past 24 Hours" for the Data View you are using. This typically will resolve that problem.

An important item to watch when reading any of these Analytics charts is the "Duration". The reason this is important is because the starting and ending TIME of the report being viewed may not precisely match up with the time-period for which you are expecting to see data. Please pay close attention to these values when interpreting these Analytics charts.