Skip to content
digizeDocs

The tap page

GET
/api/v1/cards/tap-page
curl --request GET \
  --url https://digize.com/api/v1/cards/tap-page \
  --header 'x-api-key: <x-api-key>'

What tapping a card opens: its words, where each rating goes, and its address on the business’s own domain.

Needs the reviews:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
heading
required
string
>= 1 characters <= 80 characters
ratingStyle
required
string
Allowed values: stars faces
threshold
required
integer
>= 3 <= 5
destination
required
string
Allowed values: google facebook
positive
required
object
heading
required
string
>= 1 characters <= 60 characters
message
required
string
<= 240 characters
button
required
string
>= 1 characters <= 40 characters
skip
required
boolean
negative
required
object
heading
required
string
>= 1 characters <= 60 characters
prompt
required
string
<= 160 characters
askContact
required
boolean
thanks
required
string
>= 1 characters <= 240 characters
publicLinkForAll
required
boolean
fallbackUrl
required
string
<= 500 characters /^https:\/\/[^\s/.]+\.\S+$/
hostname
required

The address new cards’ links are on, or empty until one is set up.

string
domainStatus
required
Any of:
string
Allowed values: active pending_dns verifying failed
records
required
Array<object>
object
type
required
string
Allowed values: CNAME TXT MX
name
required
string
value
required
string
priority
number
status
required
string
Allowed values: found missing mismatch
purpose
required
string
optional
boolean
verifiedAt
required
Any of:
string format: date-time
error
required
string | null
domains
required
Array<object>
object
hostname
required
string
status
required
string
Allowed values: active pending_dns verifying failed
certificate
required
string
Allowed values: active issuing waiting failed
records
required
Array<object>
object
type
required
string
Allowed values: CNAME TXT MX
name
required
string
value
required
string
priority
number
status
required
string
Allowed values: found missing mismatch
purpose
required
string
optional
boolean
error
required
string | null
addedAt
required
string format: date-time
verifiedAt
required
Any of:
string format: date-time
checkedAt
required
string format: date-time
url
required
string
updatedAt
required
Any of:
string format: date-time
updatedBy
required
string | null

Example 

{
  "ratingStyle": "stars",
  "destination": "google",
  "domainStatus": "active",
  "records": [
    {
      "type": "CNAME",
      "status": "found"
    }
  ],
  "domains": [
    {
      "status": "active",
      "certificate": "active",
      "records": [
        {
          "type": "CNAME",
          "status": "found"
        }
      ]
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}