Struct ContentApiKey 

pub struct ContentApiKey { /* private fields */ }

Content API key for authentication.

The Content API uses a simple API key mechanism where the key is passed as a query parameter (?key=…) in requests. Keys are 26-character hexadecimal strings generated by Ghost.

Format

Content API keys are 26-character hexadecimal strings (lowercase). Example: 22444f78447824223cefc48062

Security

Content API keys are safe for public use as they only grant read access to published content. They should still be treated with care to avoid quota exhaustion.

Example

use ghost_io_api::auth::content::ContentApiKey;

// Valid key
let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
assert_eq!(key.as_str(), "22444f78447824223cefc48062");

// Invalid key (too short)
let result = ContentApiKey::new("invalid");
assert!(result.is_err());

Implementations

impl ContentApiKey

pub const MIN_KEY_LENGTH: usize = 26

Minimum valid key length (26 characters).

pub const MAX_KEY_LENGTH: usize = 26

Maximum valid key length (26 characters).

pub fn new(key: impl Into<String>) -> Result<Self>

Creates a new Content API key with validation.

Validation

• Must be exactly 26 characters long
• Must contain only hexadecimal characters (0-9, a-f)
• Automatically converts uppercase to lowercase

Errors

Returns GhostError::Auth if:

• Key is not 26 characters long
• Key contains non-hexadecimal characters
• Key is empty

Example

use ghost_io_api::auth::content::ContentApiKey;

// Valid key
let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
assert!(key.is_valid());

// Invalid - too short
assert!(ContentApiKey::new("short").is_err());

// Invalid - non-hex characters
assert!(ContentApiKey::new("gggggggggggggggggggggggggg").is_err());

pub fn as_str(&self) -> &str

Returns the key as a string slice.

Example

use ghost_io_api::auth::content::ContentApiKey;

let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
assert_eq!(key.as_str(), "22444f78447824223cefc48062");

pub fn as_query_param(&self) -> String

Returns the key formatted as a query parameter.

This returns the key in the format key=<value> ready to be appended to a URL query string.

Example

use ghost_io_api::auth::content::ContentApiKey;

let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
let param = key.as_query_param();
assert_eq!(param, "key=22444f78447824223cefc48062");

// Can be used in URLs
let url = format!("https://demo.ghost.io/ghost/api/content/posts/?{}", param);
assert!(url.contains("?key="));

pub fn is_valid(&self) -> bool

Validates the key format.

Returns true if the key is valid (correct length and hex characters).

Note: This will always return true for keys created via new() since validation happens at construction time.

Example

use ghost_io_api::auth::content::ContentApiKey;

let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
assert!(key.is_valid());

Trait Implementations

impl AsRef<str> for ContentApiKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ContentApiKey

fn clone(&self) -> ContentApiKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContentApiKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ContentApiKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the key for display (shows first 8 and last 4 characters).

For security, the full key is not displayed. Use as_str() if you need the complete key.

Example

use ghost_io_api::auth::content::ContentApiKey;

let key = ContentApiKey::new("22444f78447824223cefc48062").unwrap();
let display = format!("{}", key);
assert_eq!(display, "ContentApiKey(22444f78...8062)");

impl Eq for ContentApiKey

impl PartialEq for ContentApiKey

fn eq(&self, other: &ContentApiKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContentApiKey