Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.84 KB

ConnectWidgetApi.md

File metadata and controls

53 lines (38 loc) · 1.84 KB

\ConnectWidgetApi

Method HTTP request Description
GetConnectWidget Post /users/{user_guid}/connect_widget_url Embedding in a website

GetConnectWidget

ConnectWidgetResponseBody GetConnectWidget(ctx, userGUID, body) Embedding in a website

This endpoint will return a URL for an embeddable version of MX Connect.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  userGUID := "USR-123" // string | The unique identifier for a `user`.
  body := atrium.ConnectWidgetRequestBody{} // ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

  response, _, err := client.ConnectWidget.GetConnectWidget(ctx, userGUID, body)
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userGUID string The unique identifier for a `user`.
body ConnectWidgetRequestBody Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

Return type

ConnectWidgetResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]