Home / UIN Services API

UIN Services API

UIN Manager offers an application programming interface (API) to search/verify, create, and update UINs programmatically. The UIN Services v3 API is only available to members within the A&M System after approval from the System Enterprise Applications (SEA) DevOps group.

If you have any issues or questions requesting an API key, please don’t hesitate to ask for help by emailing us at support@tamus.edu.

Existing Applications

If your application is already registered with one of SEA’s APIs using x-api authentication, you can just subscribe to the new API and request a new key following the steps in the Subscribing to an API section.

Registering a New Application

To begin using the API, you must first register your application and generate an API key in our Test environment.

  1. Click the Sign In button at the top of the API Developer portal home page in our test environment https://api-doc-test.sea.system.tamus.edu/.
  2. Choose the Applications tab then click the Register an Application link.  Complete the registration form with the information below then click the Submit button.
      • Application Name: The name of the application that will be using the API.
      • Description: Provide a rich description of your application that is recognizable from outside of your organization that includes a technical contact and email address.
      • Application Status: (Enabled by default)
      • Application Owner Information: This is the administrative owner of the application, not you as the developer
      • Application Owner Name: Typically the department head or manager
      • Application Owner Email: Preferably a group email for the development team
      • Contact Phone Number: The phone number for the department
      • Contact Name: Usually the same as the Technical Contact in the description
      • Company Website: Department website URL

Subscribing to an API

After registering your application, search the API Catalog for UIN Proxy Services v3 then select the API card and click the Subscribe button.  The application will be in a Pending status until the API key has been requested and approved.

Your applications with their subscriptions and API keys are listed under the Subscriptions tab.

Requesting an API Key

Email a subscription request to SEASupport@tamus.edu. You will receive an automated email with a ticket id.

Usually within 48 hours, you will receive a decision email.  If approved, return to the Subscriptions tab of the API Developer portal where you registered the application. Click your application name then the API name. Your API key will be displayed along with other details.

We encourage you to fully test your configuration and the various endpoints you will be using.  When you are ready to move your application to production, you will repeat the steps above in our API Developer portal in our production environment at https://api-doc.sea.system.tamus.edu/.