Connecting services to external apps

Connect a service to an external app in the console

1. Create an instance of the service.
   1. Click Catalog.
   2. From the catalog, select the service that you want by clicking the service tile.
   3. Select the location and org and space or resource group, and then click Create.
2. From the service details page, select Service Credentials to view or add credentials in JSON format.
   • To create new credentials, select New credential and optionally add configuration parameters manually or import a file in JSON format, then click Add. Select View credentials to save the credentials to connect to your external app.
   • Select a set of credentials and click View credentials in the Actions column if they already exist.
3. Use the API key that is displayed as the credentials to connect to the service instance.

Your application that runs outside of IBM Cloud can now access the IBM Cloud service.

If you want to delete service instances or check the billing information, you must go back to the Resource list page in the user interface to manage the service instances.

Connect a service to an external app by using the API

1. Create an instance of the service by calling Resource Controller API as shown in the following example request:

   curl -X POST https://resource-controller.cloud.ibm.com/v2/resource_instances -H 'Authorization: Bearer <>' -H 'Content-Type: application/json' -d '{
      "name": "my-instance",
      "target": "bluemix-global",
      "resource_group": "5g9f447903254bb58972a2f3f5a4c711",
      "resource_plan_id": "0be5ad401ae913d8ff665d92680664ed",
      "tags": [
        "my-tag"
      ]
    }'
   

   CreateResourceInstanceOptions createResourceInstanceOptions = new CreateResourceInstanceOptions.Builder()
    .name(resourceInstanceName)
    .target(targetRegion)
    .resourceGroup(resourceGroup)
    .resourcePlanId(resourcePlanId)
    .build();
   
   Response<ResourceInstance> response = service.createResourceInstance(createResourceInstanceOptions).execute();
   ResourceInstance resourceInstance = response.getResult();
   
   System.out.printf("createResourceInstance() response:\n%s\n", resourceInstance.toString());
   

   const params = {
    name: resourceInstanceName,
    target: targetRegion,
    resourceGroup: resourceGroupGuid,
    resourcePlanId: resourcePlanId,
   };
   
   resourceControllerService.createResourceInstance(params)
    .then(res => {
      instanceGuid = res.result.guid;
      console.log('createResourceInstance() response:\n' + JSON.stringify(res.result, null, 2));
    })
    .catch(err => {
      console.warn(err)
    });
   

   resource_instance = resource_controller_service.create_resource_instance(
    name=resource_instance_name,
    target=target_region,
    resource_group=resource_group,
    resource_plan_id=resource_plan_id
    ).get_result()
   
   print('\ncreate_resource_instance() response:\n',
        json.dumps(resource_instance, indent=2))
   

   createResourceInstanceOptions := resourceControllerService.NewCreateResourceInstanceOptions(
    resourceInstanceName,
    targetRegion,
    resourceGroup,
    resourcePlanID,
   )
   
   resourceInstance, response, err := resourceControllerService.CreateResourceInstance(createResourceInstanceOptions)
   if err != nil {
    panic(err)
   }
   
   b, _ := json.MarshalIndent(resourceInstance, "", "  ")
   fmt.Printf("\nCreateResourceInstance() response:\n%s\n", string(b))
   

2. Retrieve or create credentials (resource key).

   • To create new credentials, call the Resource Controller API as shown in the following example.

   curl -X POST https://resource-controller.cloud.ibm.com/v2/resource_keys -H 'Authorization: Bearer <IAM_TOKEN>' -H 'Content-Type: application/json' -d '{
    "name": "my-instance-key-1",
    "source": "267bf377-7fa2-43f6-94ec-09103a8e89d4",
    "role": "Writer"
   }'
   

   ResourceKeyPostParameters parameters = new ResourceKeyPostParameters.Builder()
    .add("exampleParameter", "exampleValue")
    .build();
   CreateResourceKeyOptions createResourceKeyOptions = new CreateResourceKeyOptions.Builder()
    .name(keyName)
    .source(instanceGuid)
    .parameters(parameters)
    .build();
   
   Response<ResourceKey> response = service.createResourceKey(createResourceKeyOptions).execute();
   ResourceKey resourceKey = response.getResult();
   
   System.out.printf("createResourceKey() response:\n%s\n", resourceKey.toString());
   

   const parameters = {
    'exampleParameter': 'exampleValue'
   };
   
   const params = {
    name: keyName,
    source: instanceGuid,
    parameters: parameters,
   };
   
   resourceControllerService.createResourceKey(params)
    .then(res => {
      instanceKeyGuid = res.result.guid;
      console.log('createResourceKey() response:\n' + JSON.stringify(res.result, null, 2));
    })
    .catch(err => {
      console.warn(err)
    });
   

   parameters = {
      'exampleParameter': 'exampleValue'
   }
   resource_key = resource_controller_service.create_resource_key(
      name=key_name,
      source=instance_guid,
      parameters=parameters
   ).get_result()
   
   print('\ncreate_resource_key() response:\n',
        json.dumps(resource_key, indent=2))
   

   createResourceKeyOptions := resourceControllerService.NewCreateResourceKeyOptions(
    keyName,
    instanceGUID,
   )
   
   parameters := &resourcecontrollerv2.ResourceKeyPostParameters{}
   parameters.SetProperty("exampleParameter", "exampleValue")
   createResourceKeyOptions.SetParameters(parameters)
   
   resourceKey, response, err := resourceControllerService.CreateResourceKey(createResourceKeyOptions)
   if err != nil {
    panic(err)
   }
   b, _ := json.MarshalIndent(resourceKey, "", "  ")
   fmt.Printf("\nCreateResourceKey() response:\n%s\n", string(b))
   

   • To retrieve service credentials, call the Resource Controller API as shown in the following example request and pass the ID associated with the instance.

   curl -X GET https://resource-controller.cloud.ibm.com/v2/resource_keys/23693f48-aaa2-4079-b0c7-334846eff8d0 -H 'Authorization: Bearer <IAM_TOKEN>'
   

   GetResourceKeyOptions getResourceKeyOptions = new GetResourceKeyOptions.Builder()
    .id(instanceKeyGuid)
    .build();
   
   Response<ResourceKey> response = service.getResourceKey(getResourceKeyOptions).execute();
   ResourceKey resourceKey = response.getResult();
   
   System.out.printf("getResourceKey() response:\n%s\n", resourceKey.toString());
   

   const params = {
    id: instanceKeyGuid,
   };
   
   resourceControllerService.getResourceKey(params)
    .then(res => {
      console.log('getResourceKey() response:\n' + JSON.stringify(res.result, null, 2));
    })
    .catch(err => {
      console.warn(err)
    });
   

   resource_key = resource_controller_service.get_resource_key(
      id=instance_key_guid
   ).get_result()
   
   print('\nget_resource_key() response:\n',
        json.dumps(resource_key, indent=2))
   

   getResourceKeyOptions := resourceControllerService.NewGetResourceKeyOptions(
    instanceKeyGUID,
   )
   
   resourceKey, response, err := resourceControllerService.GetResourceKey(getResourceKeyOptions)
   if err != nil {
    panic(err)
   }
   b, _ := json.MarshalIndent(resourceKey, "", "  ")
   fmt.Printf("\nGetResourceKey() response:\n%s\n", string(b))
   

3. Use the API key that is displayed as the credentials to connect to the service instance.