MOSIP 1.2.0 API endpoints tutorials

Support
1

Aside from the MOSIP 1.2.0 API documentation on the web, are there any tutorials on API endpoints on how to use them e.g. what are the steps; what are the commands; what are the values that need to be put in the commands.

For Example
https://dev2.mosip.net/idrepository/v1/identity/idvid/{id}
What value should be placed in {id}

https://dev2.mosip.net/idrepository/v1/identity/authtypes/status/{ID}
What value should be placed in {ID}

Is there a document or a tutorial that will explain these commands, and what are the values needed for these commands for MOSIP 1.2.0 API endpoints?

Something similar to this but for MOSIP 1.2.0 and all the API endpoints
https://docs.mosip.io/1.1.5/apis/id-repository-apis

2

Hi @rcsampang

For our new development on MOSIP, we have started using Stoplight for API documentation.

Currently, we have a few modules documented here: https://mosip.stoplight.io/

If you are looking at any specific API documentation, please let me know; we will add it to Stoplight for the time being.

Thanks and Regards,
Rounak

1 Like
3

Hello @nayakrounak

This is quite useful for a proficient API developer. But I am not yet that competent in API development, thus I am still having difficulty in understanding them.

I was hoping to find a tutorial on other commands we could use to check if our MOSIP sandbox API endpoints are working as expected similar to the one discussed previously in my earlier post.

In my previous post I asked how to find the person’s UIN

The steps given were:

  1. Please check below roles are assigned to ‘mosip-regproc-client’ service account from Keycloaks:
    Publish_Registration_Processor_workFlow_Paused_for_Additional_Info_Event_General
    Subscriber_Registration_Processor_workFlow_Paused_for_Additional_Info_Event_General.

If not, please add these roles and restart ‘regproc-notifier and regproc-workflow’ stages.

  1. Get details from ID Repo - run the command below -
    https://api-internal.yourenv.mosip.net/idrepository/v1/identity/idvid/yourRID?type=bio
    Please replace the host name and RID details as per your environment.

  2. Before trying ID Repo, please do authentication
    https://api-internal.qatriple.mosip.net/v1/authmanager/swagger-ui/index.html?configUrl=/v1/authmanager/v3/api-docs/swagger-config#/authmanager/clientIdSecretKey

You can get the clientIdSecretKey by running the command in MOSIP K8s cluster
$ echo “PMS Client Password : $( kubectl -n keycloak get secrets keycloak-client-secrets -o jsonpath={.data.mosip_regproc_client_secret} | base64 -d )”

So basically what I am looking for are other steps/commands that can be used to check the person’s registration information by leveraging the use of MOSIP API endpoints.

For example, there is this command in MOSIP 1.2.0 API documentation
(Id Repository Identity Service)

https://dev2.mosip.net/idrepository/v1/identity/authtypes/status/{ID}

What is its’ function ? Check status of the person’s registration?
What should be put in place of {ID} ? I tried RID and UIN but I got an unauthorized error prompt
Do I have to authenticate first before I run this command? How? What information are needed for the authentication?

I am trying to learn by issuing the get commands in the MOSIP API documentation ( https://mosip.github.io/documentation/1.2.0/1.2.0.html) but I don’t know where to find more information for each command, what steps to take, commands to run, and values to use.

Is there an existing tutorial for that?

4

Hi @rcsampang ,

We don’t have a proper tutorial as of now. But I will be happy to explain a couple of the APIs here.

API Type 1

If you are looking to check the status of the resident’s packet, then you can use the below resident-service API.

Swagger for Resident Services: (https://{baseURL}/resident/v1/swagger-ui/index.html?configUrl=/resident/v1/v3/api-docs/swagger-config#/resident-controller/getRidStatus))

This API doesn’t need any authentication :slight_smile:

Request URL: https://{baseURL}/resident/v1/rid/check-status

Request Body:

{
  "id": "mosip.resident.checkstatus",
  "version": "v1",
  "requesttime": "2023-06-16T11:45:08.162Z",
  "request": {
    "individualId": "11880117741004320230321171036",
    "individualIdType": "RID"
  }
}

Response Body:

{
  "id": "mosip.resident.checkstatus",
  "version": "v1",
  "responsetime": "2023-06-16T11:46:38.556Z",
  "metadata": null,
  "response": {
    "ridStatus": "PROCESSED"
  },
  "errors": null
}

API Type 2

Now there is another API in the Registration Processor to get the status of the resident’s packet.

Swagger for Registration Processor: (https://{baseURL}/registrationprocessor/v1/registrationstatus/swagger-ui/index.html?configUrl=/registrationprocessor/v1/registrationstatus/v3/api-docs/swagger-config))

This API needs authentication. Hence, you need to get an authentication token with one of the roles specified in registration-processor-default.properties.

mosip.role.registration.getPostexternalstatussearch=REGISTRATION_ADMIN,REGISTRATION_OFFICER,REGISTRATION_SUPERVISOR,RESIDENT

Here the roles supported by the API are REGISTRATION_ADMIN, REGISTRATION_OFFICER, REGISTRATION_SUPERVISOR, or RESIDENT.

For generating the authentication token with the required role, you need to use the auth manager APIs.

Swagger for Auth Manager: (https://{baseURL}/v1/authmanager/swagger-ui/index.html?configUrl=/v1/authmanager/v3/api-docs/swagger-config#/authmanager/clientIdSecretKey)

For getting this token, you need to authenticate using the client credentials, which is having the role RESIDENT, which you can find in keycloak.

Screenshot 2023-06-16 at 6.14.50 PM
Screenshot 2023-06-16 at 6.14.50 PM1215×566 71.7 KB

Request URL: https://{baseURL}/v1/authmanager/authenticate/clientidsecretkey

Request Body:

{
  "id": "string",
  "version": "string",
  "requesttime": "2023-06-16T11:44:29.563Z",
  "metadata": {},
  "request": {
    "clientId": "mosip-resident-client",
    "secretKey": "<secret from keycloak>",
    "appId": "resident"
  }
}

Response Body:

{
  "id": "string",
  "version": "string",
  "responsetime": "2023-06-16T12:48:32.532Z",
  "metadata": null,
  "response": {
    "status": "Success",
    "message": "Clientid and Token combination had been validated successfully"
  },
  "errors": null
}

Here, in the response header, you will have the authentication token below,

 access-control-allow-credentials: true 
 access-control-allow-headers: Date,Content-Type,Accept,X-Requested-With,Authorization,From,X-Auth-Token,Request-Id 
 access-control-allow-methods: POST,GET,OPTIONS,DELETE,PUT,PATCH 
 access-control-allow-origin: https://api-internal.collab.mosip.net 
 access-control-expose-headers: Set-Cookie 
 authorization: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI2SkdrUVZUZTVCcXZFeVZRemszUm8xT0hRSkdzZ0x6QVVSaS1za3A1UUMwIn0.eyJleHAiOjE2ODY5NTU3MTIsImlhdCI6MTY4NjkxOTcxMiwianRpIjoiMDI3MDJmODItNWRjNC00MTMyLWEyNGMtMjc5NTIzOGVlZTViIiwiaXNzIjoiaHR0cHM6Ly9pYW0uY29sbGFiLm1vc2lwLm5ldC9hdXRoL3JlYWxtcy9tb3NpcCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiIwZmUxMmIzYS05NzBjLTQ0NjgtYWQxZS1kOWY4ZmU0NmVkYzAiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJtb3NpcC1yZXNpZGVudC1jbGllbnQiLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIkNSRURFTlRJQUxfUkVRVUVTVCIsIlBNU19BRE1JTiIsIlJFU0lERU5UIiwiU1VCU0NSSUJFX0FVVEhfVFlQRV9TVEFUVVNfVVBEQVRFX0FDS19HRU5FUkFMIiwiUE1TX1VTRVIiLCJvZmZsaW5lX2FjY2VzcyIsIlBBUlRORVJfQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiIsImRlZmF1bHQtcm9sZXMtbW9zaXAiLCJTVUJTQ1JJQkVfQVVUSEVOVElDQVRJT05fVFJBTlNBQ1RJT05fU1RBVFVTIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsibW9zaXAtcmVzaWRlbnQtY2xpZW50Ijp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6InByb2ZpbGUgaW5kaXZpZHVhbF9pZCBlbWFpbCBpZGFfdG9rZW4gYWRkX29pZGNfY2xpZW50IHVwZGF0ZV9vaWRjX2NsaWVudCIsImNsaWVudEhvc3QiOiIxMC40Mi43LjE0MiIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiY2xpZW50SWQiOiJtb3NpcC1yZXNpZGVudC1jbGllbnQiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtbW9zaXAtcmVzaWRlbnQtY2xpZW50IiwiY2xpZW50QWRkcmVzcyI6IjEwLjQyLjcuMTQyIn0.OfXTuYU0g_hOaGIJlrjZifv2Y22TIZWgobbyMOHrwoDIE67S0YdXR8HpGG3YzrFnJ4v6_LQ_HuLY7JMBhEtsnOH7FmPUmljQZYjT56ftkjzfFZfpKR7xs6BpM0p6dSFwi34Jc7_2twXiMAtEYhOernX6jOKkAkD9AJAReyZhTC_rMME0WNurnXsV3-_xX2t1ys-2uUgqs_AT3Bm5TVu-2s5jmfNqjqtlgOdxzF1KfGdrEQKeFeNig9y7ta6Kkg2uZ8qd5QeAaUjCeTp93lgqxMnRIOWSEMqPSzB6cEf6GsqhHJod_MPTcuY1vt8a1_QVptSNge-yvVlt6ATd27873w 
 cache-control: no-cache,no-store,max-age=0,must-revalidate 
 connection: keep-alive 
 content-length: 213 
 content-type: application/json;charset=UTF-8 
 date: Fri,16 Jun 2023 12:48:32 GMT 
 expires: 0 
 pragma: no-cache 
 server: nginx/1.18.0 (Ubuntu) 
 x-content-type-options: nosniff 
 x-envoy-upstream-service-time: 79 
 x-frame-options: SAMEORIGIN 
 x-xss-protection: 1; mode=block

Now, when you use the Registration Processor API, you need to add the above token to the cookie.

Request URL: https://{baseURL}/registrationprocessor/v1/registrationstatus/packetexternalstatus

Request Body:

{
  "id": "mosip.registration.packet.external.status",
  "version": "1.0",
  "requesttime": "2023-06-16T12:59:50.079Z",
  "request": [
    {
      "packetId": "10001101070000520221112023125"
    }
  ]
}

Response Body:

{
  "response": [
    {
      "packetId": "10001101070000520221112023125",
      "statusCode": "ACCEPTED"
    }
  ],
  "errors": [],
  "id": "mosip.registration.packet.external.status",
  "version": "1.0",
  "responsetime": "2023-06-16T13:07:48.905Z"
}

Hope this will help you. Let me know if you need anything else…

2 Likes
5

Please find the curl command to add the authentication token in the cookie

curl --location 'https://qa3.mosip.net/v1/policymanager/policies/group/new' \
--header 'Content-Type: application/json' \
--header 'Cookie: Authorization=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJQbHBYczdJWG9pY0hTeldPeWVQTjdXZFl4WmhsclczQV9RbXFjUlRRaEJRIn0.eyJqdGkiOiJlYjllMjgzNi1hNmQzLTQyMjAtOTc2MS1mNzRmZTQ5NDgxNTQiLCJleHAiOjE2ODU2MzM2NDIsIm5iZiI6MCwiaWF0IjoxNjg1NTk3NjQyLCJpc3MiOiJodHRwczovL3FhMy5tb3NpcC5uZXQva2V5Y2xvYWsvYXV0aC9yZWFsbXMvbW9zaXAiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNmY0YTYzMWYtY2U2ZS00OTY4LWJmY2UtNDRkMGM3Zjc1ZDVmIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoibW9zaXAtYWRtaW4tY2xpZW50IiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiMThhMTZkYjQtMzQ0Ni00NTQwLWJiOTMtNGIwNmE5MDQ3MTFhIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwczovL3FhMy5tb3NpcC5uZXQiXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIlJFR0lTVFJBVElPTl9PRkZJQ0VSIiwiQ1JFREVOVElBTF9SRVFVRVNUIiwiQ1JFREVOVElBTF9JU1NVQU5DRSIsIkRJR0lUQUxDQVJEX0FETUlOIiwiTUVUQURBVEFfUkVBRCIsIlJFR0lTVFJBVElPTl9QUk9DRVNTT1IiLCJSRUdJU1RSQVRJT05fQURNSU4iLCJNSVNQX1BBUlRORVIiLCJQUkVfUkVHSVNUUkFUSU9OIiwiWk9OQUxfQURNSU4iLCJJRF9BVVRIRU5USUNBVElPTiIsIlJFR0lTVFJBVElPTl9TVVBFUlZJU09SIiwiTUFTVEVSREFUQV9BRE1JTiIsIkZUTV9QUk9WSURFUiIsIlBNU19VU0VSIiwib2ZmbGluZV9hY2Nlc3MiLCJaT05BTF9BUFBST1ZFUiIsIkNSRUFURV9TSEFSRSIsIlBBUlRORVJfQURNSU4iLCJ1bWFfYXV0aG9yaXphdGlvbiIsIkRJR0lUQUxfQ0FSRCIsIk1JU1AiLCJHTE9CQUxfQURNSU4iLCJQQVJUTkVSIiwiS0VZX01BS0VSIiwiUkVHSVNUUkFUSU9OX09QRVJBVE9SIiwiUkVTSURFTlQiLCJQQVJUTkVSTUFOQUdFUiIsIkFVVEhfUEFSVE5FUiIsIkRFVklDRV9QUk9WSURFUiIsIkRlZmF1bHQiLCJDRU5UUkFMX0FETUlOIiwiQ1JFREVOVElBTF9QQVJUTkVSIiwiT05MSU5FX1ZFUklGSUNBVElPTl9QQVJUTkVSIiwiQVVUSCIsIlBSRVJFRyIsIkNFTlRSQUxfQVBQUk9WRVIiLCJEQVRBX1JFQUQiLCJQT0xJQ1lNQU5BR0VSIiwiRE9DVU1FTlRfUkVBRCIsIkJJT01FVFJJQ19SRUFEIiwiQUJJU19QQVJUTkVSIiwiSU5ESVZJRFVBTCIsIlBSRV9SRUdJU1RSQVRJT05fQURNSU4iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsIm5hbWUiOiJQYXJ0bmVyIEFkbWluIiwicHJlZmVycmVkX3VzZXJuYW1lIjoicGFydG5lcmFkbWluIiwiZ2l2ZW5fbmFtZSI6IlBhcnRuZXIiLCJmYW1pbHlfbmFtZSI6IkFkbWluIiwiZW1haWwiOiJwYXJ0bmVyYWRtaW5AZ21haWwuY29tIn0.Pvs-UBpl_CbERNVKjG_2lmDZmAjo_l_4VbdNAgL7_fnl6ee1sjS_Zfhn99DyP8d9DQ0CnHyuFlRPq-wkSmdblAOXmspFN9wEh9FtlLmfvrImgI5PHy6R8YXCMvLvwfAj1Lt7XEYbcBhvDmxJxMmgi08T1Z0AsmzrDfNFyLVaV1-hMzF2Lw9FQUmDXt5WX6sGB43hiy1lXR06O87oF0j51wZoxPeRSS3eqgqCjXelT-sewDMvFe8fFJe__IObHmN_dd0_xXeKwrmc-KU6PGIEBgUgr3IHd_WIUHrVWRSHXH6-6We1uwy_SK06mZ3DZc5XScjbeZY7O8J_hl6EliLvaA' \
--data '{
  "id": "",
  "metadata": {},
  "request": {
    "desc":"policygroup",
    "name":"misp-policygroup182"
  },
  "requesttime": "2023-06-16T13:36:18.495Z",
  "version": "LTS"
}
'
1 Like
6

Thank you very much @nayakrounak This is quite helpful.

I will study them further and ask more questions later.

Best regards!

7

@anyone

Quick question, what value should be put in {ID} in this command?

https://dev2.mosip.net/idrepository/v1/identity/authtypes/status/{ID}

8

The value for ID here is UIN or VID.

This Get API is used to get all the Authentication Types and their respective Statuses for the individual.

9

Hi @nayakrounak I tried placing UIN in the command. I ended up with unauthorized error.

I tried authenticating using the command in my previous post

https://api-internal.qatriple.mosip.net/v1/authmanager/swagger-ui/index.html?configUrl=/v1/authmanager/v3/api-docs/swagger-config#/authmanager/clientIdSecretKey

I still ended up with the same unauthorized error.

What is the right way to authenticate?

10

Hi @rcsampang ,

As you can see, this is an ID REPOSITORY API - The role details to access this API will be available in id-repository-default.properties in the configurations, as shown below:

Now you need to use client credentials that have one of the roles specified against the API configuration; here the roles are RESIDENT or ID_REPOSITORY.

Make sure you are using a credential that has one of the above roles, or add one of the roles to the client that you are using.

Thanks,
Rounak